List Locations

List all locations with optional filtering and pagination.

get/v2/tms-api/locations

Request

Base URL
https://api.mentium.io (the document declares no server; this is the origin it was published from)
Auth
none declared

name_containsstring nullable

Filter by name

citystring nullable

Filter by city

statestring nullable

Filter by state/province (ISO 3166-2). Examples: US-IL, CA-ON, MX-CMX

countrystring nullable

Filter by country (ISO 3166-1 alpha-2). Examples: US, CA, MX

limitinteger

Number of items

offsetinteger

Offset for pagination

sort_bystring nullable

Sort field

sort_order'asc' | 'desc'

Sort order options.

Sort order

X-API-Keystring nullable

API key for authentication

Successful Response

total_countinteger required

Total number of items matching the query

has_moreboolean required

Whether there are more items available

limitinteger required

Number of items requested

offsetinteger required

Number of items skipped

No recorded changes to this operation across all 2 revisions of this API.