Skip to main content
GET
/
stores
/stores
curl --request GET \
  --url https://api.storeindexer.com/stores \
  --header 'x-api-key: <api-key>'
{
  "num_pages": 123,
  "total_count": 123,
  "data": [
    {
      "store_id": "<string>",
      "company_id": "<string>",
      "address_1": "<string>",
      "city": "<string>",
      "country": "<string>",
      "parent_company_id": "<string>",
      "name": "<string>",
      "address_2": "<string>",
      "province": "<string>",
      "postal_code": "<string>",
      "phone_number": "<string>",
      "is_open": true,
      "latitude": "<string>",
      "longitude": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 1000,
  "page_num": 1,
  "sort_order": "asc",
  "sort_by": "created_at"
}

Authorizations

x-api-key
string
header
required

Query Parameters

company_id
string | null
parent_company_id
string | null
city
string | null
province
string | null
country
string | null
postal_code
string | null
is_open
boolean | null
latitude
string | null
longitude
string | null
limit
integer | null
default:1000
page_num
integer | null
default:1
sort_order
enum<string> | null
default:asc
Available options:
asc,
desc
sort_by
string | null
default:created_at

Response

Successful Response

num_pages
integer
required
total_count
integer
required
data
Store · object[]
required
limit
integer
default:1000
page_num
integer
default:1
sort_order
enum<string>
default:asc
Available options:
asc,
desc
sort_by
string
default:created_at