Skimmer.PublicApi.Host | v1

ServiceLocations

Endpointhttps://publicapi.getskimmer.com

Retrieves all service locations.

GET

https://publicapi.getskimmer.com

/ServiceLocations

Retrieves all service locations. › query Parameters

includeDeleted

boolean

Default: false

Retrieves all service locations. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves all service locations. › Responses

object[]

customerId

string · required

The unique identifier of the customer associated with this service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

id

string | null

The unique identifier for the service location.

rate

number · double

The service rate charged at this location.

rateType

string · enum

The type of rate applied to the service.

Enum values:

None

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

laborCost

number · double

The labor cost associated with servicing this location.

laborCostType

string · enum

The type of labor cost applied.

Enum values:

None

PerStop

PerMonth

deleted

boolean

Indicates whether the service location has been marked as deleted.

object

The tax group.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

GET/ServiceLocations

curl --request GET \
  --url https://publicapi.getskimmer.com/ServiceLocations \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": {},
    "customerId": "customerId",
    "rate": 0,
    "rateType": "None",
    "laborCost": 0,
    "laborCostType": "None",
    "deleted": true,
    "taxGroup": {
      "id": "id",
      "deleted": true,
      "isActive": true,
      "name": "name"
    },
    "address": {},
    "city": {},
    "state": {},
    "zip": {},
    "latitude": 0,
    "longitude": 0,
    "gateCode": {},
    "dogsName": {},
    "notes": {},
    "locationCode": {},
    "minutesAtStop": 0
  }
]

plain

Updates an existing service location.

PUT

https://publicapi.getskimmer.com

/ServiceLocations

Updates an existing service location. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Updates an existing service location. › Request Body

id

string | null · required

The unique identifier for the service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object

The service rate charged at this location.

object

The labor cost associated with servicing this location.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

Updates an existing service location. › Responses

id

string | null · required

The unique identifier for the service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object

The service rate charged at this location.

object

The labor cost associated with servicing this location.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

PUT/ServiceLocations

curl --request PUT \
  --url https://publicapi.getskimmer.com/ServiceLocations \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "id": {},
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}
'

shell

Example Request Body

{
  "id": {},
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

json

Example Responses

{
  "id": {},
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

plain

Creates a new service location.

POST

https://publicapi.getskimmer.com

/ServiceLocations

Creates a new service location. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Creates a new service location. › Request Body

customerId

string · required

The unique identifier of the customer associated with this service location.

object[] · required

Bodies of water associated with the service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object

The service rate charged at this location.

object

The labor cost associated with servicing this location.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

Creates a new service location. › Responses

Created

id

string | null · required

The unique identifier for the service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object

The service rate charged at this location.

object

The labor cost associated with servicing this location.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

POST/ServiceLocations

curl --request POST \
  --url https://publicapi.getskimmer.com/ServiceLocations \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "customerId": "customerId",
  "bodiesOfWater": [
    {
      "name": {},
      "gallons": 0,
      "baselineFilterPressure": 0,
      "notes": {}
    }
  ],
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}
'

shell

Example Request Body

{
  "customerId": "customerId",
  "bodiesOfWater": [
    {
      "name": {},
      "gallons": 0,
      "baselineFilterPressure": 0,
      "notes": {}
    }
  ],
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

json

Example Responses

{
  "id": {},
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

plain

Searches all service locations.

GET

https://publicapi.getskimmer.com

/ServiceLocations/search

Searches all service locations. › query Parameters

Sorts

string

Comma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, City, State, Zip, TaxGroupId, Rate, RateType, LaborCost, LaborCostType, CreatedAt, UpdatedAt

Filters

string

A comma-delimited list of property name, operator, value.Values: Id, City, State, Zip, TaxGroupId, IsBadAddress, Rate, RateType, LaborCost, LaborCostType, CreatedAt, UpdatedAt, Deleted

Page

integer · int32

The page number to return

PageSize

integer · int32

The number of items returned per page

Searches all service locations. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Searches all service locations. › Responses

object[]

customerId

string · required

The unique identifier of the customer associated with this service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

id

string | null

The unique identifier for the service location.

rate

number · double

The service rate charged at this location.

rateType

string · enum

The type of rate applied to the service.

Enum values:

None

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

laborCost

number · double

The labor cost associated with servicing this location.

laborCostType

string · enum

The type of labor cost applied.

Enum values:

None

PerStop

PerMonth

deleted

boolean

Indicates whether the service location has been marked as deleted.

object

The tax group.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

GET/ServiceLocations/search

curl --request GET \
  --url https://publicapi.getskimmer.com/ServiceLocations/search \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": {},
    "customerId": "customerId",
    "rate": 0,
    "rateType": "None",
    "laborCost": 0,
    "laborCostType": "None",
    "deleted": true,
    "taxGroup": {
      "id": "id",
      "deleted": true,
      "isActive": true,
      "name": "name"
    },
    "address": {},
    "city": {},
    "state": {},
    "zip": {},
    "latitude": 0,
    "longitude": 0,
    "gateCode": {},
    "dogsName": {},
    "notes": {},
    "locationCode": {},
    "minutesAtStop": 0
  }
]

plain

Retrieves one service location by ID.

GET

https://publicapi.getskimmer.com

/ServiceLocations/{id}

Retrieves one service location by ID. › path Parameters

id

string · required

Retrieves one service location by ID. › query Parameters

includeDeleted

boolean

Default: false

Retrieves one service location by ID. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves one service location by ID. › Responses

customerId

string · required

The unique identifier of the customer associated with this service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object[]

Bodies of water associated with the service location.

id

string | null

The unique identifier for the service location.

rate

number · double

The service rate charged at this location.

rateType

string · enum

The type of rate applied to the service.

Enum values:

None

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

laborCost

number · double

The labor cost associated with servicing this location.

laborCostType

string · enum

The type of labor cost applied.

Enum values:

None

PerStop

PerMonth

deleted

boolean

Indicates whether the service location has been marked as deleted.

object

The tax group.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

GET/ServiceLocations/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/ServiceLocations/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "bodiesOfWater": [
    {
      "id": {},
      "serviceLocationId": {},
      "deleted": true,
      "name": {},
      "gallons": 0,
      "baselineFilterPressure": 0,
      "notes": {}
    }
  ],
  "id": {},
  "customerId": "customerId",
  "rate": 0,
  "rateType": "None",
  "laborCost": 0,
  "laborCostType": "None",
  "deleted": true,
  "taxGroup": {
    "id": "id",
    "deleted": true,
    "isActive": true,
    "name": "name"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

plain

Deletes an existing service location.

DELETE

https://publicapi.getskimmer.com

/ServiceLocations/{id}

Deletes an existing service location. › path Parameters

id

string · required

Deletes an existing service location. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Deletes an existing service location. › Responses

No Content

No data returned

DELETE/ServiceLocations/{id}

curl --request DELETE \
  --url https://publicapi.getskimmer.com/ServiceLocations/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

No example specified for this content type

WorkOrders Routes

Skimmer.PublicApi.Host | v1

ServiceLocations

Endpointhttps://publicapi.getskimmer.com

Retrieves all service locations.

GET

https://publicapi.getskimmer.com

/ServiceLocations

Retrieves all service locations. › query Parameters

includeDeleted

boolean

Default: false

Retrieves all service locations. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves all service locations. › Responses

object[]

customerId

string · required

The unique identifier of the customer associated with this service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

id

string | null

The unique identifier for the service location.

rate

number · double

The service rate charged at this location.

rateType

string · enum

The type of rate applied to the service.

Enum values:

None

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

laborCost

number · double

The labor cost associated with servicing this location.

laborCostType

string · enum

The type of labor cost applied.

Enum values:

None

PerStop

PerMonth

deleted

boolean

Indicates whether the service location has been marked as deleted.

object

The tax group.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

GET/ServiceLocations

curl --request GET \
  --url https://publicapi.getskimmer.com/ServiceLocations \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": {},
    "customerId": "customerId",
    "rate": 0,
    "rateType": "None",
    "laborCost": 0,
    "laborCostType": "None",
    "deleted": true,
    "taxGroup": {
      "id": "id",
      "deleted": true,
      "isActive": true,
      "name": "name"
    },
    "address": {},
    "city": {},
    "state": {},
    "zip": {},
    "latitude": 0,
    "longitude": 0,
    "gateCode": {},
    "dogsName": {},
    "notes": {},
    "locationCode": {},
    "minutesAtStop": 0
  }
]

plain

Updates an existing service location.

PUT

https://publicapi.getskimmer.com

/ServiceLocations

Updates an existing service location. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Updates an existing service location. › Request Body

id

string | null · required

The unique identifier for the service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object

The service rate charged at this location.

object

The labor cost associated with servicing this location.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

Updates an existing service location. › Responses

id

string | null · required

The unique identifier for the service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object

The service rate charged at this location.

object

The labor cost associated with servicing this location.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

PUT/ServiceLocations

curl --request PUT \
  --url https://publicapi.getskimmer.com/ServiceLocations \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "id": {},
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}
'

shell

Example Request Body

{
  "id": {},
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

json

Example Responses

{
  "id": {},
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

plain

Creates a new service location.

POST

https://publicapi.getskimmer.com

/ServiceLocations

Creates a new service location. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Creates a new service location. › Request Body

customerId

string · required

The unique identifier of the customer associated with this service location.

object[] · required

Bodies of water associated with the service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object

The service rate charged at this location.

object

The labor cost associated with servicing this location.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

Creates a new service location. › Responses

Created

id

string | null · required

The unique identifier for the service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object

The service rate charged at this location.

object

The labor cost associated with servicing this location.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

POST/ServiceLocations

curl --request POST \
  --url https://publicapi.getskimmer.com/ServiceLocations \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "customerId": "customerId",
  "bodiesOfWater": [
    {
      "name": {},
      "gallons": 0,
      "baselineFilterPressure": 0,
      "notes": {}
    }
  ],
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}
'

shell

Example Request Body

{
  "customerId": "customerId",
  "bodiesOfWater": [
    {
      "name": {},
      "gallons": 0,
      "baselineFilterPressure": 0,
      "notes": {}
    }
  ],
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

json

Example Responses

{
  "id": {},
  "serviceRate": {
    "cost": 0,
    "type": "PerStopIncludingChemicals"
  },
  "laborCost": {
    "cost": 0,
    "type": "PerStop"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

plain

Searches all service locations.

GET

https://publicapi.getskimmer.com

/ServiceLocations/search

Searches all service locations. › query Parameters

Sorts

string

Filters

string

A comma-delimited list of property name, operator, value.Values: Id, City, State, Zip, TaxGroupId, IsBadAddress, Rate, RateType, LaborCost, LaborCostType, CreatedAt, UpdatedAt, Deleted

Page

integer · int32

The page number to return

PageSize

integer · int32

The number of items returned per page

Searches all service locations. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Searches all service locations. › Responses

object[]

customerId

string · required

The unique identifier of the customer associated with this service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

id

string | null

The unique identifier for the service location.

rate

number · double

The service rate charged at this location.

rateType

string · enum

The type of rate applied to the service.

Enum values:

None

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

laborCost

number · double

The labor cost associated with servicing this location.

laborCostType

string · enum

The type of labor cost applied.

Enum values:

None

PerStop

PerMonth

deleted

boolean

Indicates whether the service location has been marked as deleted.

object

The tax group.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

GET/ServiceLocations/search

curl --request GET \
  --url https://publicapi.getskimmer.com/ServiceLocations/search \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": {},
    "customerId": "customerId",
    "rate": 0,
    "rateType": "None",
    "laborCost": 0,
    "laborCostType": "None",
    "deleted": true,
    "taxGroup": {
      "id": "id",
      "deleted": true,
      "isActive": true,
      "name": "name"
    },
    "address": {},
    "city": {},
    "state": {},
    "zip": {},
    "latitude": 0,
    "longitude": 0,
    "gateCode": {},
    "dogsName": {},
    "notes": {},
    "locationCode": {},
    "minutesAtStop": 0
  }
]

plain

Retrieves one service location by ID.

GET

https://publicapi.getskimmer.com

/ServiceLocations/{id}

Retrieves one service location by ID. › path Parameters

id

string · required

Retrieves one service location by ID. › query Parameters

includeDeleted

boolean

Default: false

Retrieves one service location by ID. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves one service location by ID. › Responses

customerId

string · required

The unique identifier of the customer associated with this service location.

address

string | null · required

The street address of the service location.

city

string | null · required

The city where the service location is located.

state

string | null · required

The state or province of the service location.

zip

string | null · required

The ZIP or postal code of the service location.

object[]

Bodies of water associated with the service location.

id

string | null

The unique identifier for the service location.

rate

number · double

The service rate charged at this location.

rateType

string · enum

The type of rate applied to the service.

Enum values:

None

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

laborCost

number · double

The labor cost associated with servicing this location.

laborCostType

string · enum

The type of labor cost applied.

Enum values:

None

PerStop

PerMonth

deleted

boolean

Indicates whether the service location has been marked as deleted.

object

The tax group.

latitude

number · double

The latitude coordinate of the service location.

longitude

number · double

The longitude coordinate of the service location.

gateCode

string | null

The gate access code for the service location, if applicable.

dogsName

string | null

The name of the dog at the service location, if applicable.

notes

string | null

Additional notes about the service location.

locationCode

string | null

A custom code assigned to the service location.

minutesAtStop

integer · int32

The estimated number of minutes spent at this service location per visit.

GET/ServiceLocations/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/ServiceLocations/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "bodiesOfWater": [
    {
      "id": {},
      "serviceLocationId": {},
      "deleted": true,
      "name": {},
      "gallons": 0,
      "baselineFilterPressure": 0,
      "notes": {}
    }
  ],
  "id": {},
  "customerId": "customerId",
  "rate": 0,
  "rateType": "None",
  "laborCost": 0,
  "laborCostType": "None",
  "deleted": true,
  "taxGroup": {
    "id": "id",
    "deleted": true,
    "isActive": true,
    "name": "name"
  },
  "address": {},
  "city": {},
  "state": {},
  "zip": {},
  "latitude": 0,
  "longitude": 0,
  "gateCode": {},
  "dogsName": {},
  "notes": {},
  "locationCode": {},
  "minutesAtStop": 0
}

plain

Deletes an existing service location.

DELETE

https://publicapi.getskimmer.com

/ServiceLocations/{id}

Deletes an existing service location. › path Parameters

id

string · required

Deletes an existing service location. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Deletes an existing service location. › Responses

No Content

No data returned

DELETE/ServiceLocations/{id}

curl --request DELETE \
  --url https://publicapi.getskimmer.com/ServiceLocations/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

No example specified for this content type

WorkOrders Routes