Locations

List Locations

get/brands/{brand}/locations

Request

  • Base URL: https://app.amber.ai/api/public/v1
  • URL: https://app.amber.ai/api/public/v1/brands/{brand}/locations
  • Auth: HTTP bearer

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

Query parameters

cursorstring

Opaque nextCursor from the same collection and filters. Omit on the first request.

limitinteger
namestring

Exact, case-sensitive match. Spaces and punctuation are literal.

typestring

Exact, case-sensitive match. Spaces and punctuation are literal.

countryCodestring

Exact, case-sensitive match. Spaces and punctuation are literal.

unLocodestring

Exact, case-sensitive match. Spaces and punctuation are literal.

citystring

Exact, case-sensitive match. Spaces and punctuation are literal.

postalCodestring

Exact, case-sensitive match. Spaces and punctuation are literal.

Response

A page of matching records. totalItems counts all matches across pages. When nextCursor is null, you have reached the last page.

nextCursorstring nullable required
totalItemsinteger required

Total number of matching records across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.