Skip to navigation

List venues

The venues this environment serves, sorted by code unless sort says otherwise. Page with limit and cursor.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

searchstringOptional

Case-insensitive substring of the code or display name.

codestringOptional

Only these venue codes; repeat the parameter or comma-separate.

sortstringOptional

Comma-separated code, displayName or venueId; prefix - for descending. Default code.

limitintegerOptional

Page size, 1-100; larger values are clamped. Default 50.

cursorstringOptional

nextCursor or prevCursor from a previous page, sent with the same filters and sort.

includestringOptional

total adds the exact number of matching venues.

Response

A page of venues.
asOfSeqTsNsstring or nullformat: "^[0-9]+$"

The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.

itemslist of objects
nextCursorstring or null

Pass as cursor for the next page. Null on the last page.

prevCursorstring or null

Pass as cursor for the previous page. Null on the first page.

totalinteger or null

Exact count matching the filter. Null unless include=total.

Errors

400
List Venues Request Bad Request Error
401
List Venues Request Unauthorized Error
503
List Venues Request Service Unavailable Error