List revenue share records

List all revenue share records for an organization, ordered by most recent period.

GET /advertising/api/v1/revenue-share/{organization_id}

List revenue share records

cURL

curl --request GET \
  --url https://www.closient.com/advertising/api/v1/revenue-share/{organization_id} \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "gross_revenue": "<string>",
      "platform_fee": "<string>",
      "retailer_share": "<string>",
      "platform_fee_rate": "<string>",
      "metadata": {},
      "paid_at": "2023-11-07T05:31:56Z",
      "stripe_transfer_id": ""
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

APIKeyHeaderAuthOAuthTokenAuthSessionAuth

X-API-Key · string · header · required

Path Parameters

organization_id · string<shortuuid> · required

UUID of the organization.

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

page · integer · default: 1

Page number (1-indexed).

Required range: x >= 1

page_size · integer · default: 25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

200 - application/json

OK

data · RevenueShareOut · object[] · required

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.

Show child attributes

pagination · PaginationMeta · object · required

Pagination envelope describing position within the full result set.

Show child attributes

Example:

{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}