> ## Documentation Index > Fetch the complete documentation index at: https://docs.closient.com/llms.txt > Use this file to discover all available pages before exploring further. # List revenue share records > List all revenue share records for an organization, ordered by most recent period. ## OpenAPI ````yaml /openapi/openapi-advertising.json get /advertising/api/v1/revenue-share/{organization_id} openapi: 3.1.0 info: title: Advertising API version: 1.0.0 description: > Ad campaigns, impressions, revenue share, and reporting. ## Authentication All endpoints require an API key passed via the `X-API-Key` HTTP header, unless otherwise noted. ``` X-API-Key: csb__ ``` Generate API keys in **Settings > API Keys** in your dashboard, or via the Account API. Session-based (cookie) authentication is also accepted for browser-based access. ## Rate Limits | Tier | Requests / minute | Requests / day | |-------------|-------------------|----------------| | Default | 300 | 10,000 | | Custom | Contact us | Contact us | Rate-limit headers are included on every response so callers can self-throttle without hitting our 429s ("informed governor"): - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400` - `RateLimit-Limit` — quota for the **most-restrictive** currently-active window - `RateLimit-Remaining` — requests left in that window - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew safe) Legacy `X-RateLimit-*` aliases are also emitted for back-compat. `X-RateLimit-Reset` keeps the absolute Unix-timestamp shape to avoid breaking existing consumers. When rate-limited, you receive `429 Too Many Requests` with a `retry_after_seconds` field in the error envelope and a `Retry-After` header. ## Pagination List endpoints return paginated results in this envelope: ```json { "data": [...], "pagination": { "page": 1, "page_size": 25, "total_count": 342, "total_pages": 14, "has_next": true, "has_previous": false } } ``` Use `?page=2&page_size=50` query parameters. Maximum page size is 100. ## Error Responses All errors conform to [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) with `Content-Type: application/problem+json`: ```json { "type": "https://closient.com/docs/errors/not_found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "error_code": "not_found", "retryable": false, "timestamp": "2026-03-31T12:00:00+00:00" } ``` Common error codes: `unauthorized` (401), `forbidden` (403), `not_found` (404), `validation_error` (422), `rate_limited` (429), `internal_error` (500). termsOfService: https://www.closient.com/terms/ servers: - url: https://www.closient.com security: [] tags: - name: Ads description: Record ad clicks and impression events. - name: Ad Reporting description: Campaign performance metrics and analytics. - name: Revenue Share description: Revenue share configuration and payouts. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /advertising/api/v1/revenue-share/{organization_id}: get: tags: - Revenue Share summary: List revenue share records description: >- List all revenue share records for an organization, ordered by most recent period. operationId: apps_advertising_api_revenue_share_list_revenue_shares parameters: - in: path name: organization_id schema: description: UUID of the organization. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Organization Id type: string required: true description: UUID of the organization. - in: query name: page schema: default: 1 description: Page number (1-indexed). minimum: 1 title: Page type: integer required: false description: Page number (1-indexed). - in: query name: page_size schema: default: 25 description: Number of items per page (max 100). maximum: 100 minimum: 1 title: Page Size type: integer required: false description: Number of items per page (max 100). responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedRevenueShareOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: PagedRevenueShareOut: properties: data: description: >- Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or ``page`` is past the end. items: $ref: '#/components/schemas/RevenueShareOut' title: Data type: array pagination: $ref: '#/components/schemas/PaginationMeta' description: Pagination envelope describing position within the full result set. required: - data - pagination title: PagedRevenueShareOut type: object RevenueShareOut: examples: - gross_revenue: '4500.00' id: c3d4e5f6-7890-1234-abcd-ef3456789012 metadata: {} paid_at: '2025-08-05T14:30:00Z' period_end: '2025-07-31' period_start: '2025-07-01' platform_fee: '900.00' platform_fee_rate: '0.20' retailer_share: '3600.00' status: PAID stripe_transfer_id: tr_1PxYz2ABC3def4GH properties: metadata: additionalProperties: type: string description: >- Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars. title: Metadata type: object id: description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Id type: string period_start: description: First day of the billing period. format: date title: Period Start type: string period_end: description: Last day of the billing period. format: date title: Period End type: string gross_revenue: description: Total billable ad revenue in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Gross Revenue type: string platform_fee: description: Platform fee amount in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Platform Fee type: string retailer_share: description: Amount payable to the retailer in USD. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Retailer Share type: string platform_fee_rate: description: Platform fee rate (0.00-1.00). pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Platform Fee Rate type: string status: $ref: '#/components/schemas/RevenueShareStatusEnum' description: Current status of this revenue share record. paid_at: anyOf: - format: date-time type: string - type: 'null' description: When the payment was disbursed. title: Paid At stripe_transfer_id: default: '' description: Stripe transfer ID if paid. title: Stripe Transfer Id type: string required: - id - period_start - period_end - gross_revenue - platform_fee - retailer_share - platform_fee_rate - status title: RevenueShareOut type: object PaginationMeta: description: >- Page envelope returned alongside ``data`` on every paginated list endpoint. examples: - has_next: true has_previous: false page: 1 page_size: 25 total_count: 342 total_pages: 14 properties: page: description: >- 1-indexed page number that was returned. Echoes the ``?page=`` query parameter. examples: - 1 minimum: 1 title: Page type: integer page_size: description: >- Number of items returned in ``data`` for this page. Capped at the endpoint's ``max_page_size`` (typically 100). examples: - 25 minimum: 1 title: Page Size type: integer total_count: description: Total number of items matching the query across all pages. examples: - 342 minimum: 0 title: Total Count type: integer total_pages: description: >- Total number of pages at the current ``page_size``. Always at least 1 (an empty result still reports ``total_pages: 1``). examples: - 14 minimum: 1 title: Total Pages type: integer has_next: description: >- True when ``page < total_pages`` — clients can request ``page=page+1`` to continue. examples: - true title: Has Next type: boolean has_previous: description: >- True when ``page > 1`` — clients can request ``page=page-1`` to go back. examples: - false title: Has Previous type: boolean required: - page - page_size - total_count - total_pages - has_next - has_previous title: PaginationMeta type: object RevenueShareStatusEnum: description: Mirror of ``apps.advertising.models.RevenueShareStatus``. enum: - CALCULATED - APPROVED - PAID - DISPUTED title: RevenueShareStatusEnum type: string securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````