HomeBook an Intro CallStartup Program
API Endpoints

List customers

get
https://api-stage.onsched.com/v3/customers

Retrieve customers associated with the company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Email address to filter customers

string

Name to filter customers

string

Search by name or email

string

Location ID to filter customers

string

Filter customers by exact CustomFields key/value match. Use dot notation, for example CustomFields.personId=def456. Multiple CustomFields parameters are combined with AND.

integer
Defaults to 20

Limit the number of customers returned

integer
Defaults to 1

Page number

Responses

400

Invalid query parameters, or LocationId is not a location of this company.

Updated 3 months ago

Did this page help you?
Language
Credentials
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?