Sign in
Splits

List all splits

Retrieve a paginated list of the active splits configured for your store, each with its recipients and their shares. Email invitees who have not yet accepted are shown with a masked email address.

get/v1/splits

Query parameters

page_numbernumber
Example:1

The page number for pagination.

page_sizenumber
Example:50

The number of items per page.

Response

Successfully retrieved splits

Example response

{
  "items": [
    {
      "object": "split",
      "store_id": "store_1a2b3c4d",
      "description": "Q3 revenue share",
      "type": "store",
      "type_reference": "prod_1a2b3c4d",
      "enabled": true,
      "recipients": [
        {
          "type": "percentage",
          "recipient_type": "store",
          "recipient_reference": "store_1a2b3c4d",
          "amount": 25,
          "enabled": true,
          "invite_status": "pending"
        }
      ],
      "created_at": 1735689600000
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 2
  }
}

Changes

Changed in 1 of the 4 revisions of this API.1