List of offers (not archived) for a site that can be granted to a contact
Use page[number] and page[size] parameters to paginate results:
GET /v1/offers?page[number]=1&page[size]=10GET /v1/offers?page[number]=2&page[size]=25The response includes pagination links and meta data:
{
"links": {
"self": "https://api.kajabi.com/v1/offers?page[number]=2&page[size]=10",
"first": "https://api.kajabi.com/v1/offers?page[number]=1&page[size]=10",
"prev": "https://api.kajabi.com/v1/offers?page[number]=1&page[size]=10",
"next": "https://api.kajabi.com/v1/offers?page[number]=3&page[size]=10",
"last": "https://api.kajabi.com/v1/offers?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/offers?sort=titleGET /v1/offers?sort=-titleResponse will include offers sorted by the specified field
{
"data": [
{
"id": "123",
"type": "offers",
"attributes": {
"title": "Advanced Course Bundle",
"price_in_cents": 19900,
"status": "active"
}
},
{
"id": "456",
"type": "offers",
"attributes": {
"title": "Beginner Course Bundle",
"price_in_cents": 9900,
"status": "active"
}
}
]
}
Use the fields[offers] parameter to request only specific attributes:
GET /v1/offers?fields[offers]=title,price_in_centsResponse will only include requested fields
{
"data": [{
"id": "123",
"type": "offers",
"attributes": {
"title": "Advanced Course Bundle",
"price_in_cents": 19900
}
}]
}
Use the filter[site_id] parameter to get offers for a specific site:
GET /v1/offers?filter[site_id]=123Response will only include offers for that site
{
"data": [{
"id": "456",
"type": "offers",
"attributes": {
"title": "Advanced Course Bundle",
"price_in_cents": 19900,
"status": "active"
},
"relationships": {
"site": {
"data": {
"id": "123",
"type": "sites"
}
}
}
}]
}
Use the filter[title_cont] parameter to find offers where the title contains specific text:
GET /v1/offers?filter[title_cont]=bundleResponse will include offers with matching titles
{
"data": [{
"id": "456",
"type": "offers",
"attributes": {
"title": "Advanced Course Bundle",
"price_in_cents": 19900,
"status": "active"
}
},
{
"id": "789",
"type": "offers",
"attributes": {
"title": "Basic Course Bundle",
"price_in_cents": 9900,
"status": "active"
}
}]
}
Use the filter[description_cont] parameter to find offers where the description contains specific text:
GET /v1/offers?filter[description_cont]=marketingResponse will include offers with matching descriptions
{
"data": [{
"id": "456",
"type": "offers",
"attributes": {
"title": "Marketing Course Bundle",
"description": "Complete marketing course bundle with advanced strategies",
"price_in_cents": 19900,
"status": "active"
}
},
{
"id": "789",
"type": "offers",
"attributes": {
"title": "Business Essentials",
"description": "Business fundamentals including marketing and sales",
"price_in_cents": 9900,
"status": "active"
}
}]
}
You can combine pagination, sorting, sparse fields and filtering in a single request:
GET /v1/offers?page[number]=2&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_centsResponse will include paginated and filtered offers with sparse fields
{
"data": [
{
"id": "456",
"type": "offers",
"attributes": {
"title": "Basic Course Bundle",
"price_in_cents": 9900
},
"relationships": {
"site": {
"data": {
"id": "123",
"type": "sites"
}
}
}
}
],
"links": {
"self": "https://api.kajabi.com/v1/offers?page[number]=2&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents",
"first": "https://api.kajabi.com/v1/offers?page[number]=1&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents",
"prev": "https://api.kajabi.com/v1/offers?page[number]=1&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents",
"next": null,
"last": "https://api.kajabi.com/v1/offers?page[number]=2&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents"
},
"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, price_in_cents, for descending order use '-' e.g. &sort=-price_in_cents
Number of documents
Partial attributes as specified, e.g. fields[offers]=title,price_in_cents
Filter by site_id, for example ?filter[site_id]=111
Filter by title contains, for example ?filter[title_cont]=course
Filter by description contains, for example ?filter[description_cont]=course