Skimmer.PublicApi.Host | v1

Customers

Endpoint:https://publicapi.getskimmer.com

Retrieves all customers.

GET

https://publicapi.getskimmer.com

/Customers

Retrieves all customers. › query Parameters

includeDeletedboolean
Default: false

Retrieves all customers. › 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 customers. › Responses

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Updates an existing customer.

PUT

https://publicapi.getskimmer.com

/Customers

Updates an existing customer. › 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 customer. › Request Body

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Updates an existing customer. › Responses

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Creates a new customer.

POST

https://publicapi.getskimmer.com

/Customers

Creates a new customer. › 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 customer. › Request Body

serviceLocationsarray | null · required
Service locations related to the customer
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Creates a new customer. › Responses

Created

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

serviceLocationsarray | null
Service locations related to the customer.
accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Searches all customers.

GET

https://publicapi.getskimmer.com

/Customers/search

Searches all customers. › query Parameters

Sortsstring
Comma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, FirstName, LastName, CompanyName, BillingCity, BillingState, BillingZip, CreatedAt, UpdatedAt
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, FirstName, LastName, CompanyName, BillingCity, BillingState, BillingZip, CreatedAt, UpdatedAt, Deleted, IsInactive
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all customers. › 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 customers. › Responses

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Retrieves one customer by ID.

GET

https://publicapi.getskimmer.com

/Customers/{id}

Retrieves one customer by ID. › path Parameters

idstring · required

Retrieves one customer by ID. › query Parameters

includeDeletedboolean
Default: false

Retrieves one customer 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 customer by ID. › Responses

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

serviceLocationsarray | null
Service locations related to the customer.
accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Deletes an existing customer.

DELETE

https://publicapi.getskimmer.com

/Customers/{id}

Deletes an existing customer. › path Parameters

idstring · required

Deletes an existing customer. › 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 customer. › Responses

No Content

No data returned

Deactivate one or more existing customer(s).

POST

https://publicapi.getskimmer.com

/Customers/Deactivate

Deactivate one or more existing customer(s). › 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.

Deactivate one or more existing customer(s). › Request Body

idsstring[] · required
The list of customer IDs to deactivate.

deleteRouteAssignmentsboolean | null
If true, route assignments related to the customers will be deleted.
deleteWorkOrdersboolean | null
If true, work orders associated with the customers will be deleted.
deleteWorkOrderRemindersboolean | null
If true, work order reminders associated with the customers will be deleted.
deleteTagsboolean | null
If true, tags associated with the customers will be deleted.
deleteRepeatingWorkOrdersboolean | null

Deactivate one or more existing customer(s). › Responses

No Content

No data returned

Activate one or more existing customer(s).

POST

https://publicapi.getskimmer.com

/Customers/Activate

Activate one or more existing customer(s). › 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.

Activate one or more existing customer(s). › Request Body

string

Activate one or more existing customer(s). › Responses

No Content

No data returned

DosageTypes BodiesOfWater

Skimmer.PublicApi.Host | v1

Customers

Endpoint:https://publicapi.getskimmer.com

Retrieves all customers.

GET

https://publicapi.getskimmer.com

/Customers

Retrieves all customers. › query Parameters

includeDeletedboolean
Default: false

Retrieves all customers. › 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 customers. › Responses

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Updates an existing customer.

PUT

https://publicapi.getskimmer.com

/Customers

Updates an existing customer. › 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 customer. › Request Body

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Updates an existing customer. › Responses

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Creates a new customer.

POST

https://publicapi.getskimmer.com

/Customers

Creates a new customer. › 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 customer. › Request Body

serviceLocationsarray | null · required
Service locations related to the customer
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Creates a new customer. › Responses

Created

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

serviceLocationsarray | null
Service locations related to the customer.
accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Searches all customers.

GET

https://publicapi.getskimmer.com

/Customers/search

Searches all customers. › query Parameters

Sortsstring
Comma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, FirstName, LastName, CompanyName, BillingCity, BillingState, BillingZip, CreatedAt, UpdatedAt
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, FirstName, LastName, CompanyName, BillingCity, BillingState, BillingZip, CreatedAt, UpdatedAt, Deleted, IsInactive
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all customers. › 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 customers. › Responses

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Retrieves one customer by ID.

GET

https://publicapi.getskimmer.com

/Customers/{id}

Retrieves one customer by ID. › path Parameters

idstring · required

Retrieves one customer by ID. › query Parameters

includeDeletedboolean
Default: false

Retrieves one customer 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 customer by ID. › Responses

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

serviceLocationsarray | null
Service locations related to the customer.
accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Deletes an existing customer.

DELETE

https://publicapi.getskimmer.com

/Customers/{id}

Deletes an existing customer. › path Parameters

idstring · required

Deletes an existing customer. › 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 customer. › Responses

No Content

No data returned

Deactivate one or more existing customer(s).

POST

https://publicapi.getskimmer.com

/Customers/Deactivate

Deactivate one or more existing customer(s). › 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.

Deactivate one or more existing customer(s). › Request Body

idsstring[] · required
The list of customer IDs to deactivate.

deleteRouteAssignmentsboolean | null
If true, route assignments related to the customers will be deleted.
deleteWorkOrdersboolean | null
If true, work orders associated with the customers will be deleted.
deleteWorkOrderRemindersboolean | null
If true, work order reminders associated with the customers will be deleted.
deleteTagsboolean | null
If true, tags associated with the customers will be deleted.
deleteRepeatingWorkOrdersboolean | null

Deactivate one or more existing customer(s). › Responses

No Content

No data returned

Activate one or more existing customer(s).

POST

https://publicapi.getskimmer.com

/Customers/Activate

Activate one or more existing customer(s). › 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.

Activate one or more existing customer(s). › Request Body

string

Activate one or more existing customer(s). › Responses

No Content

No data returned

DosageTypes BodiesOfWater