API Reference
Log In
API Reference

Search visits

get
https://api.stowlog.com/public/visits

Retrieve a paginated list of visit records with flexible filtering options.

Query Params
integer

The page number to retrieve.

integer
1 to 1000

The number of items per page. Public API clients may request up to 1000, a higher ceiling than the other Stowlog clients get.

string

Field to sort the results by.

string
enum

Order of sorting (asc or desc).

Allowed:
date-time

Filter visits with expectedIn >= this date (ISO 8601 format).

date-time

Filter visits with expectedIn <= this date (ISO 8601 format).

date-time

Filter visits with expectedOut >= this date (ISO 8601 format).

date-time

Filter visits with expectedOut <= this date (ISO 8601 format).

date-time

Filter visits with checkedInAt >= this date (ISO 8601 format).

date-time

Filter visits with checkedInAt <= this date (ISO 8601 format).

date-time

Filter visits with checkedOutAt >= this date (ISO 8601 format).

date-time

Filter visits with checkedOutAt <= this date (ISO 8601 format).

string

Filter by visitor email address.

string

User type ID to filter visits by.

string

Filter by visitor name.

string
enum

Status of the visits to filter by.

Allowed:
customFields
array of strings

Custom fields filters in format name,value. Example: blood-type,d

customFields
Responses

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?