Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://api.zenskar.com/products \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
default:<your-api-key>
required
​
organisation
string
header
default:<your-organisation-id>
required

Query Parameters

​
cursor
string | null

The cursor indicating a unique set of results - this should be auto generated and you get it from the next and previous fields of the response

Example:

"V2VsbCBhcmV1IGN1cmlvdxM="

​
limit
integer | null

The number of results to return - defaults to 10

Example:

10

​
order
string | null
default:-created_at
Example:

"order=created_at"

​
type
enum<string> | null
Available options:
product,
group
​
type__in
string | null
​
name
string | null
​
name__ilike
string | null
​
product_category
enum<string> | null
Available options:
group,
standalone,
bundle
​
product_category__isnull
boolean | null
​
created_at
string<date-time> | null
​
created_at__gt
string<date-time> | null
​
created_at__gte
string<date-time> | null
​
created_at__lt
string<date-time> | null
​
created_at__lte
string<date-time> | null
​
id
string<uuid> | null
​
id__in
string | null
​
id__not_in
string | null

Response

Successful Response