List products

curl -X GET "https://vzguoukmiwxvqdnabfma.supabase.co/functions/v1/api/products?page=1&limit=50" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept-Version: 1.0"

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Example Book Title",
      "isbn13": "9781234567890",
      "publishing_status_id": "status-uuid",
      "format_id": "format-uuid",
      "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "license_name": "Example License",
      "license_badge_colour": "#7C3AED",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 100,
    "total_pages": 2
  }
}

GET

api

products

curl -X GET "https://vzguoukmiwxvqdnabfma.supabase.co/functions/v1/api/products?page=1&limit=50" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept-Version: 1.0"

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Example Book Title",
      "isbn13": "9781234567890",
      "publishing_status_id": "status-uuid",
      "format_id": "format-uuid",
      "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "license_name": "Example License",
      "license_badge_colour": "#7C3AED",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 100,
    "total_pages": 2
  }
}

Returns products for the authenticated organisation. Results are ordered by created_at descending. Each item includes enriched display fields such as season_name, publisher_name, license_name, and collection summaries when those relations are set.

Headers

string

required

Organisation API key.

string

default:"1.0"

API version. Use 1.0.

Query parameters

integer

default:"1"

Page number (1-based).

integer

default:"50"

Page size. Maximum 100.

string

Case-insensitive search across title, isbn13, isbn10, and product_code.

string

Filter by publishing status UUID (ONIX List 64).

string

Filter by lifecycle status UUID.

string

Filter by product availability UUID (ONIX List 65).

string

Filter by format UUID.

string

Comma-separated embeds. Supported values: product_territories (shallow territory/market tree) and sales_rights. Omit for a lighter list payload.

Response

boolean

required

true when the request succeeds.

object[]

required

Array of enriched product objects.

object

required

Pagination metadata.

Show properties

integer

Current page.

integer

Page size used for this response.

integer

Total matching products.

integer

Total pages available.

curl -X GET "https://vzguoukmiwxvqdnabfma.supabase.co/functions/v1/api/products?page=1&limit=50" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept-Version: 1.0"

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Example Book Title",
      "isbn13": "9781234567890",
      "publishing_status_id": "status-uuid",
      "format_id": "format-uuid",
      "license_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "license_name": "Example License",
      "license_badge_colour": "#7C3AED",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 100,
    "total_pages": 2
  }
}

Last modified on July 22, 2026

API documentation

Products

Headers

Query parameters

Response

​Headers

​Query parameters

​Response

Headers

Query parameters

Response