Skip to main content
GET
/
commissions
/
{uuid}
Get a commission rule
curl --request GET \
  --url https://api.journeybee.io/v1/commissions/{uuid} \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "<string>",
  "label": "<string>",
  "payment_target": "<string>",
  "auto_assign_recipient": "<string>",
  "calculation": {
    "entries": [
      {
        "payment_stage_id": 123,
        "calculation": {
          "value": "<string>",
          "scalingConfig": {
            "customFieldId": 123,
            "tiers": [
              {
                "optionId": 123,
                "value": 123
              }
            ]
          },
          "number_of_occurrences": 123,
          "periodRates": {
            "enabled": true,
            "periods": [
              {
                "periodNumber": 123,
                "startOccurrence": 123,
                "endOccurrence": 123,
                "value": 123,
                "scalingConfig": {
                  "customFieldId": 123,
                  "tiers": [
                    {
                      "optionId": 123,
                      "value": 123
                    }
                  ]
                }
              }
            ]
          },
          "split": {
            "oneOff": {
              "value": "<string>",
              "scalingConfig": {
                "customFieldId": 123,
                "tiers": [
                  {
                    "optionId": 123,
                    "value": 123
                  }
                ]
              },
              "number_of_occurrences": 123,
              "periodRates": {
                "enabled": true,
                "periods": [
                  {
                    "periodNumber": 123,
                    "startOccurrence": 123,
                    "endOccurrence": 123,
                    "value": 123,
                    "scalingConfig": {
                      "customFieldId": 123,
                      "tiers": [
                        {
                          "optionId": 123,
                          "value": 123
                        }
                      ]
                    }
                  }
                ]
              }
            },
            "recurring": {
              "value": "<string>",
              "scalingConfig": {
                "customFieldId": 123,
                "tiers": [
                  {
                    "optionId": 123,
                    "value": 123
                  }
                ]
              },
              "number_of_occurrences": 123,
              "periodRates": {
                "enabled": true,
                "periods": [
                  {
                    "periodNumber": 123,
                    "startOccurrence": 123,
                    "endOccurrence": 123,
                    "value": 123,
                    "scalingConfig": {
                      "customFieldId": 123,
                      "tiers": [
                        {
                          "optionId": 123,
                          "value": 123
                        }
                      ]
                    }
                  }
                ]
              }
            }
          }
        }
      }
    ]
  },
  "tiers": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "categories": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "partnerships": [
    {
      "uuid": "<string>",
      "name": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

uuid
string
required
label
string
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
payment_target
string | null
required
auto_assign_recipient
string | null
required
calculation
object
required

Commission calculation with one or more payment entries triggered by deal stage changes.

tiers
object[]
required
categories
object[]
required
partnerships
object[]
required
created_at
string
required
updated_at
string
required