> ## 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/purchases/list-purchases", "feedback": "Description of the issue" } ``` Only submit feedback when you have something specific and actionable to report. # List purchases > Returns a list of purchases (offer purchases) which the current user may access ## Pagination Use `page[number]` and `page[size]` parameters to paginate results: ### Get first page of 10 items * `GET /v1/purchases?page[number]=1&page[size]=10` ### Get second page of 25 items * `GET /v1/purchases?page[number]=2&page[size]=25` The response includes pagination links and meta data: ```json { "links": { "self": "https://api.kajabi.com/v1/purchases?page[number]=2&page[size]=10", "first": "https://api.kajabi.com/v1/purchases?page[number]=1&page[size]=10", "prev": "https://api.kajabi.com/v1/purchases?page[number]=1&page[size]=10", "next": "https://api.kajabi.com/v1/purchases?page[number]=3&page[size]=10", "last": "https://api.kajabi.com/v1/purchases?page[number]=5&page[size]=10" }, "meta": { "count": 10, "total_count": 50, "total_pages": 5 } } ``` ## Sparse Fields Use the `fields[purchases]` parameter to request only specific attributes: ### Only return amount_in_cents attributes * `GET /v1/purchases?fields[purchases]=amount_in_cents` Response will only include requested fields ```json { "data": [ { "id": "123", "type": "purchases", "attributes": { "amount_in_cents": 19900 } }, { "id": "456", "type": "purchases", "attributes": { "amount_in_cents": 9900 } } ] } ``` ## Sorting Use the `sort` parameter to sort the results: ### Sort by effective_start_at in descending order * `GET /v1/purchases?sort=-effective_start_at&fields[purchases]=effective_start_at` Response will include purchases sorted by the specified field ```json { "data": [ { "id": "123", "type": "purchases", "attributes": { "effective_start_at": "2025-01-02T00:00:00.000Z" } }, { "id": "456", "type": "purchases", "attributes": { "effective_start_at": "2025-01-01T00:00:00.000Z" } } ] } ``` List of attributes that may be used to sort: multipay_payments_made, opt_in, currency, effective_start_at, cardholder_name, billing_address_zip, deactivated_at, deactivation_reason, coupon_code, source, referrer, quantity, created_at, updated_at ## Filters Use the `filter[site_id]` parameter to get purchases for a specific site: ### Get purchases for site with ID 123 * `GET /v1/purchases?filter[site_id]=123` ### Filter by customer Use the `filter[customer_id]` parameter to get purchases for a specific customer: * `GET /v1/purchases?filter[customer_id]=456789` List of attributes that may be used to filter: multipay_payments_made, opt_in, currency, effective_start_at, cardholder_name, billing_address_zip, deactivated_at, deactivation_reason, coupon_code, source, referrer, quantity, created_at, updated_at The filter param uses the following syntax: `filter[attribute_name_suffix]` with suffix for comparison: * `eq` for equals * `cont` for contains * `not_eq` for not equals * `not_cont` for not contains * `gt` for greater than * `gte` for greater than or equal * `lt` for less than * `lte` for less than or equal * `start` for starts with * `end` for ends with For example: * `GET /v1/purchases?filter[amount_in_cents_eq]=19900` * `GET /v1/purchases?filter[amount_in_cents_gt]=19900` ## OpenAPI ````yaml /openapi.yaml get /v1/purchases 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/purchases: get: tags: - Purchases summary: List purchases description: > Returns a list of purchases (offer purchases) which the current user may access ## Pagination Use `page[number]` and `page[size]` parameters to paginate results: ### Get first page of 10 items * `GET /v1/purchases?page[number]=1&page[size]=10` ### Get second page of 25 items * `GET /v1/purchases?page[number]=2&page[size]=25` The response includes pagination links and meta data: ```json { "links": { "self": "https://api.kajabi.com/v1/purchases?page[number]=2&page[size]=10", "first": "https://api.kajabi.com/v1/purchases?page[number]=1&page[size]=10", "prev": "https://api.kajabi.com/v1/purchases?page[number]=1&page[size]=10", "next": "https://api.kajabi.com/v1/purchases?page[number]=3&page[size]=10", "last": "https://api.kajabi.com/v1/purchases?page[number]=5&page[size]=10" }, "meta": { "count": 10, "total_count": 50, "total_pages": 5 } } ``` ## Sparse Fields Use the `fields[purchases]` parameter to request only specific attributes: ### Only return amount_in_cents attributes * `GET /v1/purchases?fields[purchases]=amount_in_cents` Response will only include requested fields ```json { "data": [ { "id": "123", "type": "purchases", "attributes": { "amount_in_cents": 19900 } }, { "id": "456", "type": "purchases", "attributes": { "amount_in_cents": 9900 } } ] } ``` ## Sorting Use the `sort` parameter to sort the results: ### Sort by effective_start_at in descending order * `GET /v1/purchases?sort=-effective_start_at&fields[purchases]=effective_start_at` Response will include purchases sorted by the specified field ```json { "data": [ { "id": "123", "type": "purchases", "attributes": { "effective_start_at": "2025-01-02T00:00:00.000Z" } }, { "id": "456", "type": "purchases", "attributes": { "effective_start_at": "2025-01-01T00:00:00.000Z" } } ] } ``` List of attributes that may be used to sort: multipay_payments_made, opt_in, currency, effective_start_at, cardholder_name, billing_address_zip, deactivated_at, deactivation_reason, coupon_code, source, referrer, quantity, created_at, updated_at ## Filters Use the `filter[site_id]` parameter to get purchases for a specific site: ### Get purchases for site with ID 123 * `GET /v1/purchases?filter[site_id]=123` ### Filter by customer Use the `filter[customer_id]` parameter to get purchases for a specific customer: * `GET /v1/purchases?filter[customer_id]=456789` List of attributes that may be used to filter: multipay_payments_made, opt_in, currency, effective_start_at, cardholder_name, billing_address_zip, deactivated_at, deactivation_reason, coupon_code, source, referrer, quantity, created_at, updated_at The filter param uses the following syntax: `filter[attribute_name_suffix]` with suffix for comparison: * `eq` for equals * `cont` for contains * `not_eq` for not equals * `not_cont` for not contains * `gt` for greater than * `gte` for greater than or equal * `lt` for less than * `lte` for less than or equal * `start` for starts with * `end` for ends with For example: * `GET /v1/purchases?filter[amount_in_cents_eq]=19900` * `GET /v1/purchases?filter[amount_in_cents_gt]=19900` parameters: - name: sort in: query required: false description: >- Sort order, use: created_at for descending order use '-' e.g. &sort=-created_at schema: type: string - name: page[number] in: query required: false schema: type: integer - name: page[size] in: query required: false description: Number of documents schema: type: integer - name: fields[purchases] in: query required: false description: >- Partial attributes as specified, e.g. fields[purchases]=amount_in_cents schema: type: string - name: filter[active] in: query required: false description: >- Filter by active purchases (not deactivated), for example ?filter[active]=true schema: type: boolean - name: filter[deactivated] in: query required: false description: >- Filter by deactivated purchases, for example ?filter[deactivated]=true schema: type: boolean - name: filter[referrer] in: query required: false description: Filter by referrer, for example ?filter[referrer_cont]=••••• schema: type: string - name: filter[coupon_code_eq] in: query required: false description: Filter by coupon code, for example ?filter[coupon_code_eq]=••••• 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[customer_id] in: query required: false description: Filter by customer_id, for example ?filter[customer_id]=456789 schema: type: string responses: '200': description: Success, list of purchases which the current user may access content: application/vnd.api+json: schema: $ref: '#/components/schemas/purchases_index_response' '401': description: Unauthorized, Authorization header is missing or invalid content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_not_found' '403': description: Forbidden, insufficient permission to access the resource content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_forbidden' security: - Bearer: [] components: schemas: purchases_index_response: type: object properties: data: type: array items: type: object properties: id: type: string type: type: string enum: - purchases attributes: $ref: '#/components/schemas/purchases_attributes' relationships: type: object properties: offer: type: object properties: data: type: object properties: id: type: string type: type: string customer: type: object properties: data: type: object properties: id: type: string type: type: string transactions: type: object properties: data: type: array items: type: object properties: id: type: string type: type: string products: type: object properties: data: type: array items: type: object properties: id: type: string type: type: string links: type: object properties: self: type: string current: type: string errors_not_found: 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' purchases_attributes: type: object properties: amount_in_cents: type: integer payment_type: type: string multipay_payments_made: type: - integer - 'null' opt_in: type: boolean raw_extra_contact_information: type: object currency: type: string effective_start_at: type: - string - 'null' cardholder_name: type: - string - 'null' billing_address_zip: type: - string - 'null' deactivated_at: type: - string - 'null' deactivation_reason: type: - string - 'null' coupon_code: type: - string - 'null' source: type: - string - 'null' referrer: type: - string - 'null' quantity: type: integer nullable: true created_at: type: string format: date-time readOnly: true description: ISO 8601 date-time, read only updated_at: type: string format: date-time readOnly: true description: ISO 8601 date-time, read only 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 ````