Get split rule sets

Returns your split rule sets. Send no ID to list all of them, each at its newest version. Send an ID to get one.

Request

GET /api/public/split-rule-sets
GET /api/public/split-rule-sets/{id}

URI Parameters

NameTypeDescriptionRequired
idnumberID of the rule setno

Query Parameters

NameTypeDescriptionRequired
versionnumberVersion to return instead of the newest. Only with idno

Response

A successful request returns a 200 OK status code with one rule set, or a list when you send no ID.

NameTypeDescription
idnumberID of the rule set
namestringLabel of the rule set
versionnumberVersion number
sharesarrayShares in this version (see Create split rule set)
createdAtstringWhen created (ISO 8601)
versionCreatedAtstringWhen this version was saved (ISO 8601)

Example

{
  "id": 12,
  "name": "Standard 55/30/15",
  "version": 2,
  "shares": [
    { "carrierId": 501, "type": "percent", "percent": 55, "payoutMethod": "direct" },
    { "carrierId": 502, "type": "percent", "percent": 30, "payoutMethod": "direct" },
    { "carrierId": 503, "type": "remainder", "payoutMethod": "pending" }
  ],
  "createdAt": "2026-11-09T15:00:00.000Z",
  "versionCreatedAt": "2026-11-12T10:30:00.000Z"
}

Error Responses

  • 404 Not Found: The rule set or version does not exist, or it belongs to another account

Did this page help you?