> ## 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/kajabi-payments-payouts/list-payouts", "feedback": "Description of the issue" } ``` Only submit feedback when you have something specific and actionable to report. # List payouts > List of Kajabi Payments payouts for a site. Payouts represent transfers of funds from Kajabi to the site owner's connected bank account or payment method. **Note**: Date fields are returned in UTC: * `initiated_date` - Payout creation timestamp in UTC * `estimated_arrival_date` - Expected arrival timestamp in UTC ## Pagination Use `page[number]` parameter to paginate results: ### Get first page * `GET /v1/kajabi_payments_payouts?page[number]=1&filter[site_id]=123` ### Get second page * `GET /v1/kajabi_payments_payouts?page[number]=2&filter[site_id]=123` The response includes pagination links and meta data: ```json { "links": { "self": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=2&filter[site_id]=123", "first": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=1&filter[site_id]=123", "prev": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=1&filter[site_id]=123", "next": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=3&filter[site_id]=123", "last": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=5&filter[site_id]=123" }, "meta": { "total": 50, "pagination": { "current": 2, "first": 1, "prev": 1, "next": 3, "last": 5, "records": 10, } } } ``` ## Filtering by Site Use the `filter[site_id]` parameter to filter payouts by site (required): ### Get payouts for site with ID 123 * `GET /v1/kajabi_payments_payouts?filter[site_id]=123` ## Filtering by Status Use the `filter[status]` parameter to filter payouts by status: ### Get paid payouts for site with ID 123 * `GET /v1/kajabi_payments_payouts?filter[site_id]=123&filter[status]=paid` Valid status values: * `pending` - The payout has been created but hasn't been submitted to the bank yet * `in_transit` - The payout has been submitted to the bank and is being processed * `paid` - The payout succeeded and the money has successfully reached your bank account * `failed` - Something went wrong and the payout couldn't be transferred to your account * `canceled` - The payout was canceled before it could complete ## Date Range Filtering Use the `filter[start_date]` and `filter[end_date]` parameters to filter payouts by date range: ### Get payouts between January 1st and January 31st, 2024 * `GET /v1/kajabi_payments_payouts?filter[site_id]=123&filter[start_date]=2024-01-01&filter[end_date]=2024-01-31` Response will include only payouts within the specified date range. ## Using Multiple Parameters Together You can combine multiple parameters to filter the response: ### Get paginated, filtered payouts * `GET /v1/kajabi_payments_payouts?page[number]=1&filter[site_id]=123&filter[status]=paid&filter[start_date]=2024-01-01&filter[end_date]=2024-01-31` Response will include paginated payouts matching all filters: ```json { "data": [{ "id": "payout_abc123", "type": "kajabi_payments_payouts", "attributes": { "status": "Paid", "amount": 1500.00, "currency": "USD", "initiated_date": "2024-01-10T10:00:00.000Z", "estimated_arrival_date": "2024-01-17T10:00:00.000Z", "bank_account": "Chase Bank - 1234" } }] } ``` ## OpenAPI ````yaml /openapi.yaml get /v1/kajabi_payments_payouts 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/kajabi_payments_payouts: get: tags: - Kajabi Payments Payouts summary: List payouts description: > List of Kajabi Payments payouts for a site. Payouts represent transfers of funds from Kajabi to the site owner's connected bank account or payment method. **Note**: Date fields are returned in UTC: * `initiated_date` - Payout creation timestamp in UTC * `estimated_arrival_date` - Expected arrival timestamp in UTC ## Pagination Use `page[number]` parameter to paginate results: ### Get first page * `GET /v1/kajabi_payments_payouts?page[number]=1&filter[site_id]=123` ### Get second page * `GET /v1/kajabi_payments_payouts?page[number]=2&filter[site_id]=123` The response includes pagination links and meta data: ```json { "links": { "self": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=2&filter[site_id]=123", "first": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=1&filter[site_id]=123", "prev": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=1&filter[site_id]=123", "next": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=3&filter[site_id]=123", "last": "https://api.kajabi.com/v1/kajabi_payments_payouts?page[number]=5&filter[site_id]=123" }, "meta": { "total": 50, "pagination": { "current": 2, "first": 1, "prev": 1, "next": 3, "last": 5, "records": 10, } } } ``` ## Filtering by Site Use the `filter[site_id]` parameter to filter payouts by site (required): ### Get payouts for site with ID 123 * `GET /v1/kajabi_payments_payouts?filter[site_id]=123` ## Filtering by Status Use the `filter[status]` parameter to filter payouts by status: ### Get paid payouts for site with ID 123 * `GET /v1/kajabi_payments_payouts?filter[site_id]=123&filter[status]=paid` Valid status values: * `pending` - The payout has been created but hasn't been submitted to the bank yet * `in_transit` - The payout has been submitted to the bank and is being processed * `paid` - The payout succeeded and the money has successfully reached your bank account * `failed` - Something went wrong and the payout couldn't be transferred to your account * `canceled` - The payout was canceled before it could complete ## Date Range Filtering Use the `filter[start_date]` and `filter[end_date]` parameters to filter payouts by date range: ### Get payouts between January 1st and January 31st, 2024 * `GET /v1/kajabi_payments_payouts?filter[site_id]=123&filter[start_date]=2024-01-01&filter[end_date]=2024-01-31` Response will include only payouts within the specified date range. ## Using Multiple Parameters Together You can combine multiple parameters to filter the response: ### Get paginated, filtered payouts * `GET /v1/kajabi_payments_payouts?page[number]=1&filter[site_id]=123&filter[status]=paid&filter[start_date]=2024-01-01&filter[end_date]=2024-01-31` Response will include paginated payouts matching all filters: ```json { "data": [{ "id": "payout_abc123", "type": "kajabi_payments_payouts", "attributes": { "status": "Paid", "amount": 1500.00, "currency": "USD", "initiated_date": "2024-01-10T10:00:00.000Z", "estimated_arrival_date": "2024-01-17T10:00:00.000Z", "bank_account": "Chase Bank - 1234" } }] } ``` parameters: - name: page[number] in: query required: false description: Page number for pagination, for example ?page[number]=2 schema: type: number - name: filter[site_id] in: query required: true description: >- Site ID to fetch payouts for (required), for example ?filter[site_id]=123 schema: type: string - name: filter[status] in: query required: false description: >- Filter by payout status (pending, paid, failed, canceled), for example ?filter[status]=paid schema: type: string - name: filter[start_date] in: query required: false description: >- Filter payouts after this date (ISO 8601), for example ?filter[start_date]=2024-01-01 schema: type: string - name: filter[end_date] in: query required: false description: >- Filter payouts before this date (ISO 8601), for example ?filter[end_date]=2024-12-31 schema: type: string responses: '200': description: Success, returns empty list when no payouts exist '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: 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' 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 ````