List products

List of products (not archived) that can be granted to a contact

Pagination

Use page[number] and page[size] parameters to paginate results:

Get first page of 10 items

• GET /v1/products?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/products?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/products?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/products?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/products?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/products?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/products?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Sorting

Use the sort parameter to sort the results:

Sort by title in ascending order

• GET /v1/products?sort=title

Sort by title in descending order

• GET /v1/products?sort=-title

Response will include products sorted by the specified field

{
  "data": [
    {
      "id": "123",
      "type": "products",
      "attributes": {
        "title": "Advanced Course",
        "description": "In-depth training",
        "status": "active"
      }
    },
    {
      "id": "456",
      "type": "products",
      "attributes": {
        "title": "Beginner Course",
        "description": "Introduction to basics",
        "status": "active"
      }
    }
  ]
}

Sparse Fields

Use the fields[products] parameter to request only specific attributes:

Get only title and publish_status fields

• GET /v1/products?fields[products]=title,publish_status

Response will only include the requested fields

{
  "data": [
    {
      "id": "123",
      "type": "products",
      "attributes": {
        "title": "Advanced Course",
        "publish_status": "published"
      }
    },
    {
      "id": "456",
      "type": "products",
      "attributes": {
        "title": "Beginner Course",
        "publish_status": "draft"
      }
    }
  ]
}

Filter by Site ID

Use the filter[site_id] parameter to get products for a specific site:

Get products for site with ID 123

• GET /v1/products?filter[site_id]=123

Response will only include products for that site

{
  "data": [
    {
      "id": "456",
      "type": "products",
      "attributes": {
        "title": "Advanced Course",
        "description": "In-depth training",
        "status": "active",
        "publish_status": "published"
      },
      "relationships": {
        "site": {
          "data": {
            "id": "123",
            "type": "sites"
          }
        }
      }
    }
  ]
}

Filter by Title Contains

Use the filter[title_cont] parameter to find products where the title contains specific text:

Get products with titles containing “course”

• GET /v1/products?filter[title_cont]=course

Response will include products with matching titles

{
  "data": [{
    "id": "456",
    "type": "products",
    "attributes": {
      "title": "Advanced Course",
      "description": "In-depth training",
      "status": "active",
      "publish_status": "published"
    }
  },
  {
    "id": "789",
    "type": "products",
    "attributes": {
      "title": "Beginner Course",
      "description": "Introduction to basics",
      "status": "active",
      "publish_status": "published"
    }
  }]
}

Filter by Description Contains

Use the filter[description_cont] parameter to find products where the description contains specific text:

Get products with descriptions containing “training”

• GET /v1/products?filter[description_cont]=training

Response will include products with matching descriptions

{
  "data": [{
    "id": "456",
    "type": "products",
    "attributes": {
      "title": "Advanced Course",
      "description": "In-depth training program",
      "status": "active",
      "publish_status": "published"
    }
  },
  {
    "id": "789",
    "type": "products",
    "attributes": {
      "title": "Professional Course",
      "description": "Professional training and certification",
      "status": "active",
      "publish_status": "published"
    }
  }]
}

Filter by Status

Use the filter[status_eq] parameter to find products with a specific status:

Get ready products

• GET /v1/products?filter[status_eq]=ready

Response will include products with matching status

{
  "data": [{
    "id": "456",
    "type": "products",
    "attributes": {
      "title": "Advanced Course",
      "description": "In-depth training program",
      "status": "ready",
      "publish_status": "published"
    }
  },
  {
    "id": "789",
    "type": "products",
    "attributes": {
      "title": "Professional Course",
      "description": "Professional training and certification",
      "status": "ready",
      "publish_status": "published"
    }
  }]
}

Using Multiple Parameters Together

You can combine pagination, sorting, sparse fields and filtering in a single request:

Get page 2 of products for site 123, sorted by title descending, including only title and publish_status fields

• GET /v1/products?page[number]=2&page[size]=10&sort=-title&filter[site_id]=123&fields[products]=title,publish_status

Response will include paginated and filtered products with sparse fields

{
  "data": [
    {
      "id": "456",
      "type": "products",
      "attributes": {
        "title": "Beginner Course",
        "publish_status": "draft"
      },
      "relationships": {
        "site": {
          "data": {
            "id": "123",
            "type": "sites"
          }
        }
      }
    }
  ],
  "links": {
    "self": "https://api.kajabi.com/v1/products?page[number]=2&page[size]=10&sort=-title&filter[site_id]=123&fields[products]=title,publish_status",
    "first": "https://api.kajabi.com/v1/products?page[number]=1&page[size]=10&sort=-title&filter[site_id]=123&fields[products]=title,publish_status",
    "prev": "https://api.kajabi.com/v1/products?page[number]=1&page[size]=10&sort=-title&filter[site_id]=123&fields[products]=title,publish_status",
    "next": null,
    "last": "https://api.kajabi.com/v1/products?page[number]=2&page[size]=10&sort=-title&filter[site_id]=123&fields[products]=title,publish_status"
  },
  "meta": {
    "total_pages": 2,
    "total_count": 15,
    "current_page": 2
  }
}

GET /v1/products

List products

cURL

curl --request GET \
  --url https://api.kajabi.com/v1/products \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "relationships": {
        "site": {}
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

sort · string

Sort order, use: title, description, status, for descending order use '-' e.g. &sort=-title

page[number] · number

page[size] · number

Number of documents

fields[products] · string

Partial attributes as specified, e.g. fields[products]=title,publish_status

filter[site_id] · string

Filter by site_id, for example ?filter[site_id]=111

filter[title_cont] · string

Filter by title contains, for example ?filter[title_cont]=marketing

filter[description_cont] · string

Filter by description contains, for example ?filter[description_cont]=marketing

filter[status_eq] · string

Filter by status equals, for example ?filter[status_eq]=ready

Response

200

application/vnd.api+json

Success, list of products which the current user may access

data · object[]

Show child attributes

links · object

Show child attributes