List messages

get

https://api.waitwhile.com/v2/messages

Query Params

limit

integer

1 to 100

Defaults to 20

Max number of results

startAfter

string

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

desc

boolean

Show result in descending order

locationId

string

Identifier of location

state

string

enum

Current state of message

Allowed:

visitId

string

Identifier of visit

customerId

string

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

externalCustomerId

string | null

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

fromDate

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

toDate

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful