Retrieves all customers.
query Parameters
includeDeletedHeaders
skimmer-api-keyThe 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
OK
idThe customer identifier.
billingAddressBilling street address.
billingCityBilling city
billingStateBilling state code
billingZipBilling postal code
accountCreditThe customer's available account credit balance.
isInactiveIndicates as to if the customer is not active.
deletedIndicates as to if the customer is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
A list of tags associated with the customer.
isLeadIndicates whether this customer is a lead (not yet converted to a full customer).
leadSourceNameThe name of the lead source that referred this customer.
firstNameFirst name of the customer.
lastNameLast name of the customer.
companyNameCompany name of the customer.
mobilePhoneMobile phone number of the customer.
mobileLabel1Type of phone number in the MobilePhone.
mobilePhone2Additional mobile phone number of the customer.
mobileLabel2Type of phone number in the MobilePhone2.
homePhoneHome phone number of the customer.
workPhoneWork phone number of the customer.
primaryEmailThe primary email address of the customer.
secondaryEmailThe secondary email address of the customer.
email3Additional email address of the customer.
email4Additional email address of the customer.
notesNotes about the customer.
customerCodeThe unique code assigned to the customer.
displayAsCompanyIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingIndicates whether the secondary email address is used for billing.
email3IsBillingIndicates whether the third email address is used for billing.
email4IsBillingIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsSpecifies whether service-related text messages should be sent to the customer's mobile phone.
leadSourceIdThe unique identifier of the lead source that referred this customer.
Updates an existing customer.
Headers
skimmer-api-keyThe 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
idThe customer identifier.
billingAddressBilling street address.
billingCityBilling city
billingStateBilling state code
billingZipBilling postal code
A list of tags associated with the customer.
firstNameFirst name of the customer.
lastNameLast name of the customer.
companyNameCompany name of the customer.
mobilePhoneMobile phone number of the customer.
mobileLabel1Type of phone number in the MobilePhone.
mobilePhone2Additional mobile phone number of the customer.
mobileLabel2Type of phone number in the MobilePhone2.
homePhoneHome phone number of the customer.
workPhoneWork phone number of the customer.
primaryEmailThe primary email address of the customer.
secondaryEmailThe secondary email address of the customer.
email3Additional email address of the customer.
email4Additional email address of the customer.
notesNotes about the customer.
customerCodeThe unique code assigned to the customer.
displayAsCompanyIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingIndicates whether the secondary email address is used for billing.
email3IsBillingIndicates whether the third email address is used for billing.
email4IsBillingIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsSpecifies whether service-related text messages should be sent to the customer's mobile phone.
leadSourceIdThe unique identifier of the lead source that referred this customer.
Updates an existing customer. › Responses
OK
idThe customer identifier.
billingAddressBilling street address.
billingCityBilling city
billingStateBilling state code
billingZipBilling postal code
A list of tags associated with the customer.
firstNameFirst name of the customer.
lastNameLast name of the customer.
companyNameCompany name of the customer.
mobilePhoneMobile phone number of the customer.
mobileLabel1Type of phone number in the MobilePhone.
mobilePhone2Additional mobile phone number of the customer.
mobileLabel2Type of phone number in the MobilePhone2.
homePhoneHome phone number of the customer.
workPhoneWork phone number of the customer.
primaryEmailThe primary email address of the customer.
secondaryEmailThe secondary email address of the customer.
email3Additional email address of the customer.
email4Additional email address of the customer.
notesNotes about the customer.
customerCodeThe unique code assigned to the customer.
displayAsCompanyIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingIndicates whether the secondary email address is used for billing.
email3IsBillingIndicates whether the third email address is used for billing.
email4IsBillingIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsSpecifies whether service-related text messages should be sent to the customer's mobile phone.
leadSourceIdThe unique identifier of the lead source that referred this customer.
Creates a new customer.
Headers
skimmer-api-keyThe 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
Service locations related to the customer
billingAddressBilling street address.
billingCityBilling city
billingStateBilling state code
billingZipBilling postal code
A list of tags associated with the customer.
firstNameFirst name of the customer.
lastNameLast name of the customer.
companyNameCompany name of the customer.
mobilePhoneMobile phone number of the customer.
mobileLabel1Type of phone number in the MobilePhone.
mobilePhone2Additional mobile phone number of the customer.
mobileLabel2Type of phone number in the MobilePhone2.
homePhoneHome phone number of the customer.
workPhoneWork phone number of the customer.
primaryEmailThe primary email address of the customer.
secondaryEmailThe secondary email address of the customer.
email3Additional email address of the customer.
email4Additional email address of the customer.
notesNotes about the customer.
customerCodeThe unique code assigned to the customer.
displayAsCompanyIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingIndicates whether the secondary email address is used for billing.
email3IsBillingIndicates whether the third email address is used for billing.
email4IsBillingIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsSpecifies whether service-related text messages should be sent to the customer's mobile phone.
leadSourceIdThe unique identifier of the lead source that referred this customer.
Creates a new customer. › Responses
Created
idThe customer identifier.
billingAddressBilling street address.
billingCityBilling city
billingStateBilling state code
billingZipBilling postal code
Service locations related to the customer.
accountCreditThe customer's available account credit balance.
isInactiveIndicates as to if the customer is not active.
deletedIndicates as to if the customer is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
A list of tags associated with the customer.
isLeadIndicates whether this customer is a lead (not yet converted to a full customer).
leadSourceNameThe name of the lead source that referred this customer.
firstNameFirst name of the customer.
lastNameLast name of the customer.
companyNameCompany name of the customer.
mobilePhoneMobile phone number of the customer.
mobileLabel1Type of phone number in the MobilePhone.
mobilePhone2Additional mobile phone number of the customer.
mobileLabel2Type of phone number in the MobilePhone2.
homePhoneHome phone number of the customer.
workPhoneWork phone number of the customer.
primaryEmailThe primary email address of the customer.
secondaryEmailThe secondary email address of the customer.
email3Additional email address of the customer.
email4Additional email address of the customer.
notesNotes about the customer.
customerCodeThe unique code assigned to the customer.
displayAsCompanyIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingIndicates whether the secondary email address is used for billing.
email3IsBillingIndicates whether the third email address is used for billing.
email4IsBillingIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsSpecifies whether service-related text messages should be sent to the customer's mobile phone.
leadSourceIdThe unique identifier of the lead source that referred this customer.
Searches all customers.
query Parameters
SortsComma-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
FiltersA comma-delimited list of property name, operator, value.Values: Id, FirstName, LastName, CompanyName, BillingCity, BillingState, BillingZip, CreatedAt, UpdatedAt, MobilePhone, MobilePhone2, HomePhone, WorkPhone, PrimaryEmail, SecondaryEmail, Email3, Email4, Deleted, IsInactive
PageThe page number to return
PageSizeThe number of items returned per page
Headers
skimmer-api-keyThe 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
OK
idThe customer identifier.
billingAddressBilling street address.
billingCityBilling city
billingStateBilling state code
billingZipBilling postal code
accountCreditThe customer's available account credit balance.
isInactiveIndicates as to if the customer is not active.
deletedIndicates as to if the customer is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
A list of tags associated with the customer.
isLeadIndicates whether this customer is a lead (not yet converted to a full customer).
leadSourceNameThe name of the lead source that referred this customer.
firstNameFirst name of the customer.
lastNameLast name of the customer.
companyNameCompany name of the customer.
mobilePhoneMobile phone number of the customer.
mobileLabel1Type of phone number in the MobilePhone.
mobilePhone2Additional mobile phone number of the customer.
mobileLabel2Type of phone number in the MobilePhone2.
homePhoneHome phone number of the customer.
workPhoneWork phone number of the customer.
primaryEmailThe primary email address of the customer.
secondaryEmailThe secondary email address of the customer.
email3Additional email address of the customer.
email4Additional email address of the customer.
notesNotes about the customer.
customerCodeThe unique code assigned to the customer.
displayAsCompanyIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingIndicates whether the secondary email address is used for billing.
email3IsBillingIndicates whether the third email address is used for billing.
email4IsBillingIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsSpecifies whether service-related text messages should be sent to the customer's mobile phone.
leadSourceIdThe unique identifier of the lead source that referred this customer.
Retrieves one customer by ID.
path Parameters
idquery Parameters
includeDeletedHeaders
skimmer-api-keyThe 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
OK
idThe customer identifier.
billingAddressBilling street address.
billingCityBilling city
billingStateBilling state code
billingZipBilling postal code
Service locations related to the customer.
accountCreditThe customer's available account credit balance.
isInactiveIndicates as to if the customer is not active.
deletedIndicates as to if the customer is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
A list of tags associated with the customer.
isLeadIndicates whether this customer is a lead (not yet converted to a full customer).
leadSourceNameThe name of the lead source that referred this customer.
firstNameFirst name of the customer.
lastNameLast name of the customer.
companyNameCompany name of the customer.
mobilePhoneMobile phone number of the customer.
mobileLabel1Type of phone number in the MobilePhone.
mobilePhone2Additional mobile phone number of the customer.
mobileLabel2Type of phone number in the MobilePhone2.
homePhoneHome phone number of the customer.
workPhoneWork phone number of the customer.
primaryEmailThe primary email address of the customer.
secondaryEmailThe secondary email address of the customer.
email3Additional email address of the customer.
email4Additional email address of the customer.
notesNotes about the customer.
customerCodeThe unique code assigned to the customer.
displayAsCompanyIndicates as to if the customer should be displayed as a company.
primaryEmailIsBillingIndicates whether the primary email address is used for billing.
secondaryEmailIsBillingIndicates whether the secondary email address is used for billing.
email3IsBillingIndicates whether the third email address is used for billing.
email4IsBillingIndicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsSpecifies whether service-related text messages should be sent to the customer's mobile phone.
leadSourceIdThe unique identifier of the lead source that referred this customer.
Deactivate one or more existing customer(s).
Headers
skimmer-api-keyThe 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
idsThe list of customer IDs to deactivate.
deleteRouteAssignmentsIf true, route assignments related to the customers will be deleted.
deleteWorkOrdersIf true, work orders associated with the customers will be deleted.
deleteWorkOrderRemindersIf true, work order reminders associated with the customers will be deleted.
deleteTagsIf true, tags associated with the customers will be deleted.
deleteRepeatingWorkOrdersDeactivate one or more existing customer(s). › Responses
No Content