List of products (not archived) that can be granted to a contact
Use page[number] and page[size] parameters to paginate results:
GET /v1/products?page[number]=1&page[size]=10GET /v1/products?page[number]=2&page[size]=25The 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
}
}
Use the sort parameter to sort the results:
GET /v1/products?sort=titleGET /v1/products?sort=-titleResponse 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"
}
}
]
}
Use the fields[products] parameter to request only specific attributes:
GET /v1/products?fields[products]=title,publish_statusResponse 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"
}
}
]
}
Use the filter[site_id] parameter to get products for a specific site:
GET /v1/products?filter[site_id]=123Response 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"
}
}
}
}
]
}
Use the filter[title_cont] parameter to find products where the title contains specific text:
GET /v1/products?filter[title_cont]=courseResponse 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"
}
}]
}
Use the filter[description_cont] parameter to find products where the description contains specific text:
GET /v1/products?filter[description_cont]=trainingResponse 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"
}
}]
}
Use the filter[status_eq] parameter to find products with a specific status:
GET /v1/products?filter[status_eq]=readyResponse 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"
}
}]
}
You can combine pagination, sorting, sparse fields and filtering in a single request:
GET /v1/products?page[number]=2&page[size]=10&sort=-title&filter[site_id]=123&fields[products]=title,publish_statusResponse 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
}
}
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Sort order, use: title, description, status, for descending order use '-' e.g. &sort=-title
Number of documents
Partial attributes as specified, e.g. fields[products]=title,publish_status
Filter by site_id, for example ?filter[site_id]=111
Filter by title contains, for example ?filter[title_cont]=marketing
Filter by description contains, for example ?filter[description_cont]=marketing
Filter by status equals, for example ?filter[status_eq]=ready