> ## Documentation Index > Fetch the complete documentation index at: https://help.kajabi.com/llms.txt > Use this file to discover all available pages before exploring further. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback: POST https://help.kajabi.com/feedback ```json { "path": "/api-reference/offers/list-offers", "feedback": "Description of the issue" } ``` Only submit feedback when you have something specific and actionable to report. # List offers > List of offers (not archived) for a site 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/offers?page[number]=1&page[size]=10` ### Get second page of 25 items * `GET /v1/offers?page[number]=2&page[size]=25` The response includes pagination links and meta data: ```json { "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 } } ``` ## Sorting Use the `sort` parameter to sort the results: ### Sort by title in ascending order * `GET /v1/offers?sort=title` ### Sort by title in descending order * `GET /v1/offers?sort=-title` Response will include offers sorted by the specified field ```json { "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" } } ] } ``` ## Sparse Fields Use the `fields[offers]` parameter to request only specific attributes: ### Only return title and price_in_cents attributes * `GET /v1/offers?fields[offers]=title,price_in_cents` Response will only include requested fields ```json { "data": [{ "id": "123", "type": "offers", "attributes": { "title": "Advanced Course Bundle", "price_in_cents": 19900 } }] } ``` ## Filter by Site ID Use the `filter[site_id]` parameter to get offers for a specific site: ### Get offers for site with ID 123 * `GET /v1/offers?filter[site_id]=123` Response will only include offers for that site ```json { "data": [{ "id": "456", "type": "offers", "attributes": { "title": "Advanced Course Bundle", "price_in_cents": 19900, "status": "active" }, "relationships": { "site": { "data": { "id": "123", "type": "sites" } } } }] } ``` ## Filter by Title Contains Use the `filter[title_cont]` parameter to find offers where the title contains specific text: ### Get offers with titles containing "bundle" * `GET /v1/offers?filter[title_cont]=bundle` Response will include offers with matching titles ```json { "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" } }] } ``` ## Filter by Description Contains Use the `filter[description_cont]` parameter to find offers where the description contains specific text: ### Get offers with descriptions containing "marketing" * `GET /v1/offers?filter[description_cont]=marketing` Response will include offers with matching descriptions ```json { "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" } }] } ``` ## Using Multiple Parameters Together You can combine pagination, sorting, sparse fields and filtering in a single request: ### Get page 2 of offers for site 123, sorted by price_in_cents descending, including only title and price_in_cents fields * `GET /v1/offers?page[number]=2&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents` Response will include paginated and filtered offers with sparse fields ```json { "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 } } ``` ## OpenAPI ````yaml /openapi.yaml get /v1/offers openapi: 3.1.1 info: title: Kajabi API V1 version: 1.0.1 description: > ## Public API * Server URL `https://api.kajabi.com` * Endpoint paths are prefixed with `/v1` * Version endpoint `GET https://api.kajabi.com/v1/version` * See the [Developers Site](https://developers.kajabi.com) for documentation and examples. * Try the demo [Postman collection](https://www.postman.com/kajabi-apis/beta-public-api-demo/collection/fg4iyaz/kajabi-public-api-v1) ## API Keys * Your API `client_id` and `client_secret` are available on the [User API Keys](https://app.kajabi.com/admin/settings/security) section of the Kajabi Admin Portal. * Custom API Keys can be created with specific permissions. * Click the "Create User API Key" button, enter a name (e.g. "My project"), select the user and permissions, and click "Create". * For security purposes, you may "Delete" or "Rotate" the api credentials at any time; which will invalidate any access tokens granted with the credentials. ## Video Walkthroughs * [Capabilities](https://drive.google.com/file/d/1Puc9B2sSdA-RQb7YMxmUXg4FVoEXytoc/view?usp=sharing) * [Getting Started](https://drive.google.com/file/d/1hbGRShkxven_QMWvgYrerHKURbcZrnvJ/view?usp=sharing) * [Error Examples](https://drive.google.com/file/d/1i0wQK71I1jpaZVsxYwsn62gVj40S_E7Y/view?usp=sharing) * [External Contact Form](https://drive.google.com/file/d/1HqpULXvan5TOK3LvM7nILCuCkCaX0kFT/view?usp=sharing) contact: email: support@kajabi.com name: Support url: >- https://help.kajabi.com/hc/en-us/articles/4404549690523-How-to-Get-Help-From-Kajabi-Live-Agents license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.kajabi.com description: Production security: [] paths: /v1/offers: get: tags: - Offers summary: List offers description: > List of offers (not archived) for a site 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/offers?page[number]=1&page[size]=10` ### Get second page of 25 items * `GET /v1/offers?page[number]=2&page[size]=25` The response includes pagination links and meta data: ```json { "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 } } ``` ## Sorting Use the `sort` parameter to sort the results: ### Sort by title in ascending order * `GET /v1/offers?sort=title` ### Sort by title in descending order * `GET /v1/offers?sort=-title` Response will include offers sorted by the specified field ```json { "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" } } ] } ``` ## Sparse Fields Use the `fields[offers]` parameter to request only specific attributes: ### Only return title and price_in_cents attributes * `GET /v1/offers?fields[offers]=title,price_in_cents` Response will only include requested fields ```json { "data": [{ "id": "123", "type": "offers", "attributes": { "title": "Advanced Course Bundle", "price_in_cents": 19900 } }] } ``` ## Filter by Site ID Use the `filter[site_id]` parameter to get offers for a specific site: ### Get offers for site with ID 123 * `GET /v1/offers?filter[site_id]=123` Response will only include offers for that site ```json { "data": [{ "id": "456", "type": "offers", "attributes": { "title": "Advanced Course Bundle", "price_in_cents": 19900, "status": "active" }, "relationships": { "site": { "data": { "id": "123", "type": "sites" } } } }] } ``` ## Filter by Title Contains Use the `filter[title_cont]` parameter to find offers where the title contains specific text: ### Get offers with titles containing "bundle" * `GET /v1/offers?filter[title_cont]=bundle` Response will include offers with matching titles ```json { "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" } }] } ``` ## Filter by Description Contains Use the `filter[description_cont]` parameter to find offers where the description contains specific text: ### Get offers with descriptions containing "marketing" * `GET /v1/offers?filter[description_cont]=marketing` Response will include offers with matching descriptions ```json { "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" } }] } ``` ## Using Multiple Parameters Together You can combine pagination, sorting, sparse fields and filtering in a single request: ### Get page 2 of offers for site 123, sorted by price_in_cents descending, including only title and price_in_cents fields * `GET /v1/offers?page[number]=2&page[size]=10&sort=-price_in_cents&filter[site_id]=123&fields[offers]=title,price_in_cents` Response will include paginated and filtered offers with sparse fields ```json { "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 } } ``` parameters: - name: sort in: query required: false description: >- Sort order, use: title, price_in_cents, for descending order use '-' e.g. &sort=-price_in_cents schema: type: string - name: page[number] in: query required: false schema: type: number - name: page[size] in: query required: false description: Number of documents schema: type: number - name: fields[offers] in: query required: false description: >- Partial attributes as specified, e.g. fields[offers]=title,price_in_cents schema: type: string - name: filter[site_id] in: query required: false description: Filter by site_id, for example ?filter[site_id]=111 schema: type: string - name: filter[title_cont] in: query required: false description: Filter by title contains, for example ?filter[title_cont]=course schema: type: string - name: filter[description_cont] in: query required: false description: >- Filter by description contains, for example ?filter[description_cont]=course schema: type: string responses: '200': description: Success, list of offers which the current user may access content: application/vnd.api+json: schema: $ref: '#/components/schemas/offers_index_response' '401': description: Unauthorized, Authorization header is missing or invalid content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_unauthorized' '403': description: Forbidden, insufficient permission to access the resource content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_forbidden' security: - Bearer: [] components: schemas: offers_index_response: type: object properties: data: type: array items: type: object properties: id: type: string type: type: string attributes: $ref: '#/components/schemas/offers_attributes' relationships: type: object properties: site: type: object properties: data: $ref: '#/components/schemas/resource_identifier' products: type: object properties: data: type: array items: $ref: '#/components/schemas/resource_identifier' links: type: object properties: self: type: string current: type: string errors_unauthorized: type: object properties: errors: type: array items: $ref: '#/components/schemas/errors_attributes' errors_forbidden: type: object properties: errors: type: array items: $ref: '#/components/schemas/errors_attributes' offers_attributes: type: object properties: title: type: string description: type: - string - 'null' internal_title: type: - string - 'null' currency: type: string price_in_cents: type: integer payment_type: type: string token: type: string payment_method: type: string price_description: type: string checkout_url: type: string recurring_offer: type: boolean subscription: type: boolean one_time: type: boolean single: type: boolean free: type: boolean image_url: type: - string - 'null' required: - title resource_identifier: type: object properties: id: type: string type: type: string required: - id - type errors_attributes: type: object properties: status: type: string source: type: object nullable: true properties: pointer: type: string title: type: string detail: type: string securitySchemes: Bearer: type: http scheme: bearer ````