v3

latestOpenAPI 3.1.0Proprietary (Listings API Terms of Service)2026-07-3156148214.6 KB
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 return, counting forward from the start of the result set.

afterstring

Cursor to page forward from. Pass pageInfo.endCursor, or equivalently the cursor of the last edge in the previous page. Stop paging when pageInfo.hasNextPage is false, or when a page returns an empty edges array.

Response

Successful response

totalCountinteger