Skip to main content
GET
/stores

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
Required range: 1 <= x <= 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