Skip to main content
GET
List catalogue items

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

clinic_id
string<uuid>
required

Query Parameters

q
string

Free-text name match. Labelled as a text match, never as equivalence.

barcode
string

Exact match on the stored barcode. This filter is not checked as a GTIN, so a stored value that is not a valid GTIN can still be found.

category
string
status
enum<string>
default:all

Which items to list. active hides archived items, archived lists only archived items, all (the default) returns both, as this list always has.

Available options:
active,
archived,
all
updated_since
string<date-time>
limit
integer
default:25
Required range: 1 <= x <= 100
starting_after
string

Response

OK.

data
object[]
required
has_more
boolean
required
next_cursor
string | null
required