GET
/
v1
/
products

Authorizations

x-api-key
string
headerrequired

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Query Parameters

name
string

Filter products by name.

status
enum<string>

Filter products by status.

Available options:
ACTIVE,
DRAFT,
INACTIVE
grade
integer

Filter products by grade (1-10).

Required range: 1 < x < 10
min_registered_at
string

Filter products registered after the specified date.

max_registered_at
string

Filter products registered before the specified date.

is_vaulted
boolean

Filter products by vaulted status.

limit
integer

The maximum number of items to return (1-1000).

Required range: 1 < x < 1000
offset
integer

The number of items to skip before starting to collect the result set.

order
enum<string>

The sort order of the results.

Available options:
asc,
desc
order_by
string

The field by which to order the results.

Response

200 - application/json
data
object[]

List of products.

pagination
object
Get collection tapsGet product