v1
latestOpenAPI 3.0.12026-07-13139143370.4 KBCustomers
List Customers
Use this endpoint to return a List of Customers. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.
get/setup/v1/customers
Query parameters
locationIdstring
id of business location, defaults to primary business location
groupIdstring
Filter by groupId
emailstring
Filter by email address.
lastnamestring
Search by lastname.
deletedboolean
Filter by deleted status.
offsetinteger
Starting row of page, default 0
limitinteger
Page limit default 20, max 100
Response
Success