Zum Hauptinhalt springen
GET
/
api
/
commissions
/
plans
List commission plans
curl --request GET \
  --url https://coreapi.io/api/commissions/plans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "percentage": "<string>",
      "basisType": "<string>",
      "triggerEvent": "<string>",
      "commissionScope": "<string>",
      "requireDeal": true,
      "payoutThresholdAmount": {
        "amount": 123,
        "displayAmount": 123,
        "currency": "<string>",
        "precision": 123
      },
      "monthlyRevenueThreshold": {
        "amount": 123,
        "displayAmount": 123,
        "currency": "<string>",
        "precision": 123
      },
      "isActive": true,
      "rules": [
        {
          "id": "<string>",
          "productId": "<string>",
          "externalProductReference": "<string>",
          "percentage": "<string>",
          "priority": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "count": 123,
    "total": 123
  },
  "pagination": {
    "cursor": "<string>",
    "hasMore": true,
    "nextCursor": "<string>",
    "prevCursor": "<string>",
    "limit": 20,
    "totalItems": 123,
    "itemsPerPage": 123,
    "currentPage": 123,
    "totalPages": 123,
    "pageTotalItems": 123
  }
}

Autorisierungen

Authorization
string
header
erforderlich

Bearer token of your Organisation with the commission-plans permission (read for GET, write for POST/PUT/DELETE). Send it as Authorization: Bearer .

Abfrageparameter

name
string

Filter by a name substring.

type
string

Filter by plan type.

isActive
boolean

Filter by active state.

sort
enum<string>
Verfügbare Optionen:
createdAt,
name
order
enum<string>
Verfügbare Optionen:
asc,
desc
cursor
string

Cursor for cursor-based pagination.

limit
integer
Standard:20
page
integer

Switches to page-based pagination.

Antwort

A paginated list of commission plans.

data
object[]
meta
object
pagination
object

Pagination metadata. Cursor based fields are present for the default cursor mode, page based fields are present when you pass page or offset.