Locations

Search for locations.

Returns a cursor-paginated list of locations matching a keyword, searchable by name, address, or store ID.

get/api/v4/locations/search

Query parameters

querystring

Search keyword matched against location name, street address, city, and store ID. Omit to page through every location.

filterstring

JSON-encoded filter object

JSON-encoded filter object to narrow results (for example by folder or approval status).

firstinteger

Number of records to fetch, starting from the most recent.

afterstring

Cursor to fetch records after (forward pagination). Pass the previous page's pageInfo.endCursor.

Response

Successful response

totalCountinteger

Changes