GET
/v1/terminal/locationsList Terminal locations
Lists Terminal locations that group readers. Use cursor parameters to retrieve successive or previous pages and limit to control the number of locations returned. Results include location objects and pagination metadata.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
ending_beforestringoptional
A location object ID that defines the end of the page when retrieving earlier results.
expandarray<string>optional
Fields to expand in each location in the response. Each value must not exceed 5000 characters.
limitintegeroptional
The number of locations to return. Must be between 1 and 100 and defaults to 10 when omitted.
starting_afterstringoptional
A location object ID that defines the start of the page when retrieving later results.
200Returns a list object containing Terminal location objects in `data`, a `has_more` pagination flag, the list object type, and the request URL.
dataarray<Location>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultReturns an error object containing an error type and, when available, details such as a message, parameter, code, or documentation URL.
errorobjectrequired
Error handling
limit must be between 1 and 100 when provided, and defaults to 10 when omitted. Use starting_after or ending_before with location object IDs to navigate the list; each expand value must not exceed 5000 characters.