Retrieves all customers.
query Parameters
includeDeletedbooleanDefault: false
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Responses
OK
idstring · requiredThe customer identifier.
billingAddressstring | null · requiredBilling street address.
billingCitystring | null · requiredBilling city
billingStatestring | null · requiredBilling state code
billingZipstring | null · requiredBilling postal code
accountCreditnumber · doubleThe customer's available account credit balance.
isInactivebooleanIndicates as to if the customer is not active.
deletedbooleanIndicates as to if the customer is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
tagsarray | nullA list of tags associated with the customer.
firstNamestring | nullFirst name of the customer.
lastNamestring | nullLast name of the customer.
companyNamestring | nullCompany name of the customer.
mobilePhonestring | nullMobile phone number of the customer.
mobileLabel1string | nullType of phone number in the MobilePhone.
mobilePhone2string | nullAdditional mobile phone number of the customer.
mobileLabel2string | nullType of phone number in the MobilePhone2.
homePhonestring | nullHome phone number of the customer.
workPhonestring | nullWork phone number of the customer.
primaryEmailstring | nullThe primary email address of the customer.
secondaryEmailstring | nullThe secondary email address of the customer.
email3string | nullAdditional email address of the customer.
email4string | nullAdditional email address of the customer.
notesstring | nullNotes about the customer.
customerCodestring | nullThe unique code assigned to the customer.
displayAsCompanybooleanIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingbooleanIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingbooleanIndicates whether the secondary email address is used for billing.
email3IsBillingbooleanIndicates whether the third email address is used for billing.
email4IsBillingbooleanIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsbooleanSpecifies whether service-related text messages should be sent to the customer's mobile phone.
Updates an existing customer.
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Request Body
idstring · requiredThe customer identifier.
billingAddressstring | null · requiredBilling street address.
billingCitystring | null · requiredBilling city
billingStatestring | null · requiredBilling state code
billingZipstring | null · requiredBilling postal code
tagsarray | nullA list of tags associated with the customer.
firstNamestring | nullFirst name of the customer.
lastNamestring | nullLast name of the customer.
companyNamestring | nullCompany name of the customer.
mobilePhonestring | nullMobile phone number of the customer.
mobileLabel1string | nullType of phone number in the MobilePhone.
mobilePhone2string | nullAdditional mobile phone number of the customer.
mobileLabel2string | nullType of phone number in the MobilePhone2.
homePhonestring | nullHome phone number of the customer.
workPhonestring | nullWork phone number of the customer.
primaryEmailstring | nullThe primary email address of the customer.
secondaryEmailstring | nullThe secondary email address of the customer.
email3string | nullAdditional email address of the customer.
email4string | nullAdditional email address of the customer.
notesstring | nullNotes about the customer.
customerCodestring | nullThe unique code assigned to the customer.
displayAsCompanybooleanIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingbooleanIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingbooleanIndicates whether the secondary email address is used for billing.
email3IsBillingbooleanIndicates whether the third email address is used for billing.
email4IsBillingbooleanIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsbooleanSpecifies whether service-related text messages should be sent to the customer's mobile phone.
Responses
OK
idstring · requiredThe customer identifier.
billingAddressstring | null · requiredBilling street address.
billingCitystring | null · requiredBilling city
billingStatestring | null · requiredBilling state code
billingZipstring | null · requiredBilling postal code
tagsarray | nullA list of tags associated with the customer.
firstNamestring | nullFirst name of the customer.
lastNamestring | nullLast name of the customer.
companyNamestring | nullCompany name of the customer.
mobilePhonestring | nullMobile phone number of the customer.
mobileLabel1string | nullType of phone number in the MobilePhone.
mobilePhone2string | nullAdditional mobile phone number of the customer.
mobileLabel2string | nullType of phone number in the MobilePhone2.
homePhonestring | nullHome phone number of the customer.
workPhonestring | nullWork phone number of the customer.
primaryEmailstring | nullThe primary email address of the customer.
secondaryEmailstring | nullThe secondary email address of the customer.
email3string | nullAdditional email address of the customer.
email4string | nullAdditional email address of the customer.
notesstring | nullNotes about the customer.
customerCodestring | nullThe unique code assigned to the customer.
displayAsCompanybooleanIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingbooleanIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingbooleanIndicates whether the secondary email address is used for billing.
email3IsBillingbooleanIndicates whether the third email address is used for billing.
email4IsBillingbooleanIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsbooleanSpecifies whether service-related text messages should be sent to the customer's mobile phone.
Creates a new customer.
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Request Body
serviceLocationsarray | null · requiredService locations related to the customer
billingAddressstring | null · requiredBilling street address.
billingCitystring | null · requiredBilling city
billingStatestring | null · requiredBilling state code
billingZipstring | null · requiredBilling postal code
tagsarray | nullA list of tags associated with the customer.
firstNamestring | nullFirst name of the customer.
lastNamestring | nullLast name of the customer.
companyNamestring | nullCompany name of the customer.
mobilePhonestring | nullMobile phone number of the customer.
mobileLabel1string | nullType of phone number in the MobilePhone.
mobilePhone2string | nullAdditional mobile phone number of the customer.
mobileLabel2string | nullType of phone number in the MobilePhone2.
homePhonestring | nullHome phone number of the customer.
workPhonestring | nullWork phone number of the customer.
primaryEmailstring | nullThe primary email address of the customer.
secondaryEmailstring | nullThe secondary email address of the customer.
email3string | nullAdditional email address of the customer.
email4string | nullAdditional email address of the customer.
notesstring | nullNotes about the customer.
customerCodestring | nullThe unique code assigned to the customer.
displayAsCompanybooleanIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingbooleanIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingbooleanIndicates whether the secondary email address is used for billing.
email3IsBillingbooleanIndicates whether the third email address is used for billing.
email4IsBillingbooleanIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsbooleanSpecifies whether service-related text messages should be sent to the customer's mobile phone.
Responses
Created
idstring · requiredThe customer identifier.
billingAddressstring | null · requiredBilling street address.
billingCitystring | null · requiredBilling city
billingStatestring | null · requiredBilling state code
billingZipstring | null · requiredBilling postal code
serviceLocationsarray | nullService locations related to the customer.
accountCreditnumber · doubleThe customer's available account credit balance.
isInactivebooleanIndicates as to if the customer is not active.
deletedbooleanIndicates as to if the customer is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
tagsarray | nullA list of tags associated with the customer.
firstNamestring | nullFirst name of the customer.
lastNamestring | nullLast name of the customer.
companyNamestring | nullCompany name of the customer.
mobilePhonestring | nullMobile phone number of the customer.
mobileLabel1string | nullType of phone number in the MobilePhone.
mobilePhone2string | nullAdditional mobile phone number of the customer.
mobileLabel2string | nullType of phone number in the MobilePhone2.
homePhonestring | nullHome phone number of the customer.
workPhonestring | nullWork phone number of the customer.
primaryEmailstring | nullThe primary email address of the customer.
secondaryEmailstring | nullThe secondary email address of the customer.
email3string | nullAdditional email address of the customer.
email4string | nullAdditional email address of the customer.
notesstring | nullNotes about the customer.
customerCodestring | nullThe unique code assigned to the customer.
displayAsCompanybooleanIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingbooleanIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingbooleanIndicates whether the secondary email address is used for billing.
email3IsBillingbooleanIndicates whether the third email address is used for billing.
email4IsBillingbooleanIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsbooleanSpecifies whether service-related text messages should be sent to the customer's mobile phone.
Searches all customers.
query Parameters
SortsstringComma-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
FiltersstringA comma-delimited list of property name, operator, value.Values: Id, FirstName, LastName, CompanyName, BillingCity, BillingState, BillingZip, CreatedAt, UpdatedAt, Deleted, IsInactive
Pageinteger · int32The page number to return
PageSizeinteger · int32The number of items returned per page
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Responses
OK
idstring · requiredThe customer identifier.
billingAddressstring | null · requiredBilling street address.
billingCitystring | null · requiredBilling city
billingStatestring | null · requiredBilling state code
billingZipstring | null · requiredBilling postal code
accountCreditnumber · doubleThe customer's available account credit balance.
isInactivebooleanIndicates as to if the customer is not active.
deletedbooleanIndicates as to if the customer is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
tagsarray | nullA list of tags associated with the customer.
firstNamestring | nullFirst name of the customer.
lastNamestring | nullLast name of the customer.
companyNamestring | nullCompany name of the customer.
mobilePhonestring | nullMobile phone number of the customer.
mobileLabel1string | nullType of phone number in the MobilePhone.
mobilePhone2string | nullAdditional mobile phone number of the customer.
mobileLabel2string | nullType of phone number in the MobilePhone2.
homePhonestring | nullHome phone number of the customer.
workPhonestring | nullWork phone number of the customer.
primaryEmailstring | nullThe primary email address of the customer.
secondaryEmailstring | nullThe secondary email address of the customer.
email3string | nullAdditional email address of the customer.
email4string | nullAdditional email address of the customer.
notesstring | nullNotes about the customer.
customerCodestring | nullThe unique code assigned to the customer.
displayAsCompanybooleanIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingbooleanIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingbooleanIndicates whether the secondary email address is used for billing.
email3IsBillingbooleanIndicates whether the third email address is used for billing.
email4IsBillingbooleanIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsbooleanSpecifies whether service-related text messages should be sent to the customer's mobile phone.
Retrieves one customer by ID.
path Parameters
idstring · required
query Parameters
includeDeletedbooleanDefault: false
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Responses
OK
idstring · requiredThe customer identifier.
billingAddressstring | null · requiredBilling street address.
billingCitystring | null · requiredBilling city
billingStatestring | null · requiredBilling state code
billingZipstring | null · requiredBilling postal code
serviceLocationsarray | nullService locations related to the customer.
accountCreditnumber · doubleThe customer's available account credit balance.
isInactivebooleanIndicates as to if the customer is not active.
deletedbooleanIndicates as to if the customer is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
tagsarray | nullA list of tags associated with the customer.
firstNamestring | nullFirst name of the customer.
lastNamestring | nullLast name of the customer.
companyNamestring | nullCompany name of the customer.
mobilePhonestring | nullMobile phone number of the customer.
mobileLabel1string | nullType of phone number in the MobilePhone.
mobilePhone2string | nullAdditional mobile phone number of the customer.
mobileLabel2string | nullType of phone number in the MobilePhone2.
homePhonestring | nullHome phone number of the customer.
workPhonestring | nullWork phone number of the customer.
primaryEmailstring | nullThe primary email address of the customer.
secondaryEmailstring | nullThe secondary email address of the customer.
email3string | nullAdditional email address of the customer.
email4string | nullAdditional email address of the customer.
notesstring | nullNotes about the customer.
customerCodestring | nullThe unique code assigned to the customer.
displayAsCompanybooleanIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingbooleanIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingbooleanIndicates whether the secondary email address is used for billing.
email3IsBillingbooleanIndicates whether the third email address is used for billing.
email4IsBillingbooleanIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsbooleanSpecifies whether service-related text messages should be sent to the customer's mobile phone.
Deactivate one or more existing customer(s).
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Request Body
idsstring[] · requiredThe list of customer IDs to deactivate.
deleteRouteAssignmentsboolean | nullIf true, route assignments related to the customers will be deleted.
deleteWorkOrdersboolean | nullIf true, work orders associated with the customers will be deleted.
deleteWorkOrderRemindersboolean | nullIf true, work order reminders associated with the customers will be deleted.
deleteTagsboolean | nullIf true, tags associated with the customers will be deleted.
deleteRepeatingWorkOrdersboolean | null
Responses
No Content