Search visit activity logs

get

https://api.stowlog.com/public/visits/activity-logs

Retrieve a paginated list of the activity log entries of the visits of the facility the API token belongs to. Entries are sorted by occurredAt descending unless sortField and sortOrder say otherwise; ties are broken by entry id in the same direction, so paging is stable. Deleted visits keep their history: their deletion is a VISIT_DELETED entry. A change to a visitor custom field is reported on each of the visitor's open visits as a VISIT_UPDATED entry whose change field is appUserCustomFields.<key>; its previousValue and newValue are { value, selectedOptions: [{ id, label }] }, or null when there is no answer. Unknown query parameters are rejected with 400.

Query Params

page

integer

≥ 0

The page number to retrieve, starting at 1. It only takes effect when limit is also sent; without limit the first page is returned.

limit

integer

1 to 1000

Defaults to 10

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

sortField

string

Defaults to occurredAt

Field to sort the results by. Defaults to occurredAt.

sortOrder

string

enum

Defaults to desc

Order of sorting (asc or desc). Defaults to desc.

Allowed:

string

Only entries that changed a field whose name contains this text, case-insensitive. It matches changes[].field, so entries without changes are not returned when it is sent.

occurredAtFrom

date-time

Only entries with occurredAt >= this date (ISO 8601 format).

occurredAtTo

date-time

Only entries with occurredAt <= this date (ISO 8601 format).

visitId

string

Only entries of this visit. Must be a valid ObjectId (24 hexadecimal characters), otherwise the request is rejected with 400.

actions

array of objects

Only entries with any of these actions. Repeat the parameter or send a comma-separated list.

actions

Allowed:

contexts

array of objects

Only entries with any of these contexts. Repeat the parameter or send a comma-separated list.

contexts

Allowed:

excludedContexts

array of strings

Exclude entries with any of these contexts. Repeat the parameter or send a comma-separated list. Send PUBLIC_API to only read changes made outside this API.

excludedContexts

Allowed:

Responses

200A paginated response containing a list of visit activity log entries.

400The request parameters are invalid. Branch on errorCode, not message.