API Reference
Back to Waitwhile ↗︎

List visits

get
https://api.waitwhile.com/v2/visits
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Pagination

All List endpoints have a max. results limit of 100 (with the default being set to 20), however, pagination can be utilized to retrieve additional batches of results past this max. The initial response will include startAt and endAt values. Paginated result batches can be retrieved by making additional calls with the startAfter param value set to be whatever the endAt value was in the previous response.

Query Params
integer
1 to 100
Defaults to 20

Max number of results

string

Identifier(s) or value(s) to paginate results (comma-separated)

boolean

Show result in descending order

string

Identifier of location

string | null
enum

State of visit

Allowed:
string
enum

Tag associated with visit

string

Identifier of customer, automatically derived from visitor contact information if not provided.

string | null

External customer identifier, optionally provided by client. Will take priority over other contact info when deriving customerId

string

Identifier of service

string

Identifier of resource

string

Local date and time in YYYY-MM-DDThh:mm format

string

Local date and time in YYYY-MM-DDThh:mm format

Date and time in ISO-8601 format or milliseconds from epoch

Date in ISO-8601 format

Date and time in ISO-8601 format or milliseconds from epoch

Date in ISO-8601 format

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

Updated 9 months ago

What’s Next

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

What’s Next