Skimmer.PublicApi.Host | v1

ServiceLocations

Endpoint:https://publicapi.getskimmer.com

Retrieves all service locations.

GET

https://publicapi.getskimmer.com

/ServiceLocations

Retrieves all service locations. › query Parameters

includeDeletedboolean
Default: false

Retrieves all service locations. › Headers

skimmer-api-keystring · 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

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Updates an existing service location.

PUT

https://publicapi.getskimmer.com

/ServiceLocations

Updates an existing service location. › Headers

skimmer-api-keystring · 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

idstring | null · required
The unique identifier for the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Updates an existing service location. › Responses

idstring | null · required
The unique identifier for the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Creates a new service location.

POST

https://publicapi.getskimmer.com

/ServiceLocations

Creates a new service location. › Headers

skimmer-api-keystring · 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

customerIdstring · required
The unique identifier of the customer associated with this service location.
bodiesOfWaterobject[] · required
Bodies of water associated with the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Creates a new service location. › Responses

Created

idstring | null · required
The unique identifier for the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Searches all service locations.

GET

https://publicapi.getskimmer.com

/ServiceLocations/search

Searches all service locations. › query Parameters

Sortsstring
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
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, City, State, Zip, TaxGroupId, IsBadAddress, Rate, RateType, LaborCost, LaborCostType, CreatedAt, UpdatedAt, Deleted
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all service locations. › Headers

skimmer-api-keystring · 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

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Retrieves one service location by ID.

GET

https://publicapi.getskimmer.com

/ServiceLocations/{id}

Retrieves one service location by ID. › path Parameters

idstring · required

Retrieves one service location by ID. › query Parameters

includeDeletedboolean
Default: false

Retrieves one service location by ID. › Headers

skimmer-api-keystring · 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

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

bodiesOfWaterobject[]
Bodies of water associated with the service location.
idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Deletes an existing service location.

DELETE

https://publicapi.getskimmer.com

/ServiceLocations/{id}

Deletes an existing service location. › path Parameters

idstring · required

Deletes an existing service location. › Headers

skimmer-api-keystring · 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

Products

Retrieves all service locations.

GET

https://publicapi.getskimmer.com

/ServiceLocations

Retrieves all service locations. › query Parameters

includeDeletedboolean
Default: false

Retrieves all service locations. › Headers

skimmer-api-keystring · 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

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Updates an existing service location.

PUT

https://publicapi.getskimmer.com

/ServiceLocations

Updates an existing service location. › Headers

skimmer-api-keystring · 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

idstring | null · required
The unique identifier for the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Updates an existing service location. › Responses

idstring | null · required
The unique identifier for the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Creates a new service location.

POST

https://publicapi.getskimmer.com

/ServiceLocations

Creates a new service location. › Headers

skimmer-api-keystring · 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

customerIdstring · required
The unique identifier of the customer associated with this service location.
bodiesOfWaterobject[] · required
Bodies of water associated with the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Creates a new service location. › Responses

Created

idstring | null · required
The unique identifier for the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Searches all service locations.

GET

https://publicapi.getskimmer.com

/ServiceLocations/search

Searches all service locations. › query Parameters

Sortsstring
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
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, City, State, Zip, TaxGroupId, IsBadAddress, Rate, RateType, LaborCost, LaborCostType, CreatedAt, UpdatedAt, Deleted
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all service locations. › Headers

skimmer-api-keystring · 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

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Retrieves one service location by ID.

GET

https://publicapi.getskimmer.com

/ServiceLocations/{id}

Retrieves one service location by ID. › path Parameters

idstring · required

Retrieves one service location by ID. › query Parameters

includeDeletedboolean
Default: false

Retrieves one service location by ID. › Headers

skimmer-api-keystring · 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

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

bodiesOfWaterobject[]
Bodies of water associated with the service location.
idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

Deletes an existing service location.

DELETE

https://publicapi.getskimmer.com

/ServiceLocations/{id}

Deletes an existing service location. › path Parameters

idstring · required

Deletes an existing service location. › Headers

skimmer-api-keystring · 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