Skip to main content
GET
List businesses

Authorizations

Authorization
string
header
required

A bearer token obtained through one of the two flows below.

Scopes

watches:read

Read the watches in your inventory

Headers

Accept-Language
enum<string>

The language to answer in: specificationLabels, translatedDescription, facet and label names, the content pages, and every other translated word in the answer. Read on every request, whatever the endpoint. One we do not have falls back to English rather than failing.

Available options:
en,
nl,
de,
es,
fr,
it,
pt,
fi,
pl

Query Parameters

include
enum<string>

Related resources to return alongside, comma separated:

  • images — the shop's own pictures: their logo, and whatever else is on their page.
  • cover — the one picture across the top of the shop's page, with the same sizes as a listing's images. null for a shop without one.
  • statistics — what the business has been paid and what is waiting for them. Comes back null without orders:read and for a shop you do not act for: a shop page is one question, its turnover is another.

There is deliberately no watches: a seller's inventory is thousands of listings, asked for at /v1/sellers/{sellerId}/watches where it is paged.

Available options:
images,
cover,
statistics
filter[q]
string

The directory only. A shop's name, matched the way the website matches it.

filter[country]
string

The directory only. An ISO country code, from meta.facets.country.

filter[slug]
string

How an app arrives at a shop — a link carries a slug, not an id.

sort
enum<string>
Available options:
name,
-name
page[number]
integer
Required range: x >= 1
page[size]
integer
default:25

25 when left out, at most 50; more is 400. See Paging above.

Required range: 1 <= x <= 50

Response

The businesses this token may act for — or, for the app, the shop directory.

data
object[]
required
included
object[]

Present when the answer is a page.

meta
object

page when the answer is a page: from, to, perPage and hasMore for a cursor (from and to are cursors, not numbers), or currentPage, from, lastPage, perPage, to and total for numbered pages. Some lists add their own beside it, such as statusCounts, unread or facets.