> ## Documentation Index > Fetch the complete documentation index at: https://docs.journeybee.io/llms.txt > Use this file to discover all available pages before exploring further. # List commission rules > Returns commission rule configurations. Filter by `partner_type` (referral/reseller/distributor) or `payment_target` (`partnership` for partner commissions, `individual` for spiffs paid to individual users/contacts). Each commission rule contains a `calculation` object with `entries` — an array of payment triggers. Each entry specifies when payment occurs (`payment_stage_id`) and how it's calculated (`calculation.type`: oneOff, recurring, or split). ## OpenAPI ````yaml /openapi.json get /commissions/ openapi: 3.1.0 info: title: Journeybee API description: >- Public REST API for the Journeybee PRM platform. Manage partners, leads, deals, products, pricing calculators, tasks, and more programmatically. All endpoints require authentication via API key. Use `Authorization: Bearer ` or `Api-Key ` header. See the [Authentication guide](/guides/authentication) for details. version: 1.0.0 servers: - url: https://api.journeybee.io/v1 description: Production security: - apiKey: [] tags: - name: Account description: >- Authenticated company account info, API key permissions, and enabled modules - name: Analytics description: >- Dashboard analytics and reporting — commission, engagement, LMS, and partner revenue metrics - name: Assets description: File and media asset management - name: Attributions description: Attribution type definitions - name: Audit Log description: Unified audit log of company activity (read-only) - name: Automations description: Workflow automation rule configurations - name: Campaign Audience description: Audience filters on a campaign - name: Campaign Partners description: Partners shared into a campaign audience - name: Campaigns description: Partner marketing campaigns - name: Card Assignees description: Assigned users on a card - name: Card Partners description: Partners linked to a card - name: Card Tags description: Tags on a card - name: Cards description: Kanban project cards - name: Categories description: Partner categories - name: Certification Categories description: Categories on a certification - name: Certification Enrollments description: User enrollments in a certification - name: Certification Folders description: Folders on a certification - name: Certification Resources description: Curriculum resources in a certification - name: Certifications description: LMS certifications - name: Commissions description: >- Commission rule configurations with calculation entries, tier/category/partnership scoping - name: Contacts description: Partner contacts across partnerships - name: Currencies description: Available currencies - name: Custom Field Options description: Options on select/multi-select custom fields - name: Custom Field Rules description: Visibility and requirement rules on custom fields - name: Custom Field Values description: Custom field values - name: Custom Fields description: Custom field definitions - name: Deal Commission description: Commission calculation on a deal - name: Deal Custom Field Values description: Custom field values on a deal - name: Deal Notes description: Notes on a deal - name: Deal Payments description: Payment records on a deal (read-only) - name: Deal Products description: Products attached to a deal - name: Deal Stages description: Deal pipeline stages - name: Deal Tags description: Tags on a deal - name: Deal Tasks description: Tasks on a deal - name: Deals description: Deal management - name: Folders description: Content folders - name: Lead Attributions description: Attribution records on a lead - name: Lead Contacts description: Partner contacts on a lead - name: Lead Custom Field Values description: Custom field values on a lead - name: Lead Distributor description: Distributors for a lead - name: Lead Notes description: Notes on a lead - name: Lead Products description: Products attached to a lead - name: Lead Quotes description: >- Quotes on a lead — generated from pricing calculators with line items and totals - name: Lead Tags description: Tags on a lead - name: Lead Tasks description: Tasks on a lead - name: Lead Users description: Assigned users on a lead - name: Leads description: Lead management - name: Marketing Templates description: Marketing email templates - name: Partner Contacts description: Contacts on a partner - name: Partner Custom Field Values description: Custom field values on a partner - name: Partner Domains description: Domains on a partner - name: Partner Notes description: Notes on a partner - name: Partner Resellers description: Reseller assignments on a distributor - name: Partner Stages description: Partner pipeline stages - name: Partner Tags description: Tags on a partner - name: Partner Users description: Assigned users on a partner - name: Partners description: Core partner CRUD - name: Pricing Calculator Fields description: Input fields on a pricing calculator - name: Pricing Calculator Formulas description: Discount/tax/surcharge formulas on a pricing calculator - name: Pricing Calculator Products description: Products attached to a pricing calculator - name: Pricing Calculators description: Pricing calculator configurations - name: Products description: Product catalog - name: Resource Blocks description: Content blocks within a resource - name: Resource Categories description: Categories on a resource - name: Resource Folders description: Folders on a resource - name: Resource Tags description: Tags on a resource - name: Resources description: Learning resources - name: Room Blocks description: Content blocks within a room - name: Room Categories description: Category-based room access control - name: Room Partnerships description: Direct partnership room access - name: Room Stages description: Stage-based room access control - name: Room Tags description: Tag-based room access control - name: Room Tiers description: Tier-based room access control - name: Rooms description: Partner portal rooms - name: Tags description: Tag definitions - name: Task Users description: Assigned users on a task - name: Tasks description: Task management - name: Tiers description: Partner tiers - name: Users description: Company team members - name: Webhook Events description: Outbound webhook payloads sent to your configured URLs when events occur paths: /commissions/: get: tags: - Commissions summary: List commission rules description: >- Returns commission rule configurations. Filter by `partner_type` (referral/reseller/distributor) or `payment_target` (`partnership` for partner commissions, `individual` for spiffs paid to individual users/contacts). Each commission rule contains a `calculation` object with `entries` — an array of payment triggers. Each entry specifies when payment occurs (`payment_stage_id`) and how it's calculated (`calculation.type`: oneOff, recurring, or split). operationId: listCommissions parameters: - schema: default: 1 type: integer minimum: 1 maximum: 9007199254740991 in: query name: page required: false - schema: default: 25 type: integer minimum: 1 maximum: 100 in: query name: per_page required: false - schema: type: string enum: - referral - reseller - distributor in: query name: partner_type required: false - schema: type: string enum: - partnership - individual in: query name: payment_target required: false - schema: type: string maxLength: 200 in: query name: search required: false responses: '200': description: Default Response content: application/json: schema: type: object properties: data: type: array items: type: object properties: uuid: type: string label: type: string partner_type: type: string enum: - referral - reseller - distributor payment_target: anyOf: - type: string enum: - partnership - individual - type: 'null' auto_assign_recipient: anyOf: - type: string enum: - lead_creator - deal_owner - manual - type: 'null' calculation: type: object properties: entries: type: array items: type: object properties: payment_stage_id: anyOf: - type: number - type: 'null' description: >- Deal stage ID that triggers payment. Null = manual trigger. calculation: type: object properties: type: type: string enum: - oneOff - recurring - split option: description: >- fixed: flat amount. percentage: % of deal value. scaling: varies by custom field. anyOf: - type: string enum: - fixed - percentage - scaling - type: 'null' value: description: Amount (fixed) or percentage anyOf: - anyOf: - type: string - type: number - type: 'null' scalingConfig: anyOf: - type: object properties: customFieldId: type: number description: >- Custom field whose value determines the tier tiers: type: array items: type: object properties: optionId: type: number description: Custom field option ID option: type: string enum: - fixed - percentage description: Calculation method value: type: number description: Amount or percentage required: - optionId - option - value additionalProperties: false required: - customFieldId - tiers additionalProperties: false description: >- Scaling — commission varies based on a custom field option. - type: 'null' recurring_period: description: Payment frequency anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' number_of_occurrences: description: Total recurring payments anyOf: - anyOf: - type: number - type: string - type: 'null' periodRates: anyOf: - type: object properties: enabled: type: boolean periods: type: array items: type: object properties: periodNumber: type: number startOccurrence: type: number description: First occurrence this rate applies to endOccurrence: anyOf: - type: number - type: 'null' description: Last occurrence (null = unlimited) option: type: string enum: - fixed - percentage - scaling value: type: number scalingConfig: type: object properties: customFieldId: type: number description: >- Custom field whose value determines the tier tiers: type: array items: type: object properties: optionId: type: number description: Custom field option ID option: type: string enum: - fixed - percentage description: Calculation method value: type: number description: Amount or percentage required: - optionId - option - value additionalProperties: false required: - customFieldId - tiers additionalProperties: false description: >- Scaling — commission varies based on a custom field option. required: - periodNumber - startOccurrence - endOccurrence - option - value additionalProperties: false required: - enabled - periods additionalProperties: false description: >- Variable rates per period range in recurring commissions. - type: 'null' split: description: >- Split: combines one-time + recurring payments. type: object properties: oneOff: type: object properties: type: description: >- oneOff: single payment when stage reached. recurring: periodic payments. anyOf: - type: string enum: - oneOff - recurring - type: 'null' option: description: >- fixed: flat amount. percentage: % of deal value. scaling: varies by custom field. anyOf: - type: string enum: - fixed - percentage - scaling - type: 'null' value: description: Amount (fixed) or percentage anyOf: - anyOf: - type: string - type: number - type: 'null' scalingConfig: anyOf: - type: object properties: customFieldId: type: number description: >- Custom field whose value determines the tier tiers: type: array items: type: object properties: optionId: type: number description: Custom field option ID option: type: string enum: - fixed - percentage description: Calculation method value: type: number description: Amount or percentage required: - optionId - option - value additionalProperties: false required: - customFieldId - tiers additionalProperties: false description: >- Scaling — commission varies based on a custom field option. - type: 'null' recurring_period: description: Payment frequency anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' number_of_occurrences: description: Total recurring payments anyOf: - anyOf: - type: number - type: string - type: 'null' periodRates: anyOf: - type: object properties: enabled: type: boolean periods: type: array items: type: object properties: periodNumber: type: number startOccurrence: type: number description: First occurrence this rate applies to endOccurrence: anyOf: - type: number - type: 'null' description: Last occurrence (null = unlimited) option: type: string enum: - fixed - percentage - scaling value: type: number scalingConfig: type: object properties: customFieldId: type: number description: >- Custom field whose value determines the tier tiers: type: array items: type: object properties: optionId: {} option: {} value: {} required: - optionId - option - value additionalProperties: false required: - customFieldId - tiers additionalProperties: false description: >- Scaling — commission varies based on a custom field option. required: - periodNumber - startOccurrence - endOccurrence - option - value additionalProperties: false required: - enabled - periods additionalProperties: false description: >- Variable rates per period range in recurring commissions. - type: 'null' additionalProperties: false description: One-time payment component recurring: type: object properties: type: description: >- oneOff: single payment when stage reached. recurring: periodic payments. anyOf: - type: string enum: - oneOff - recurring - type: 'null' option: description: >- fixed: flat amount. percentage: % of deal value. scaling: varies by custom field. anyOf: - type: string enum: - fixed - percentage - scaling - type: 'null' value: description: Amount (fixed) or percentage anyOf: - anyOf: - type: string - type: number - type: 'null' scalingConfig: anyOf: - type: object properties: customFieldId: type: number description: >- Custom field whose value determines the tier tiers: type: array items: type: object properties: optionId: type: number description: Custom field option ID option: type: string enum: - fixed - percentage description: Calculation method value: type: number description: Amount or percentage required: - optionId - option - value additionalProperties: false required: - customFieldId - tiers additionalProperties: false description: >- Scaling — commission varies based on a custom field option. - type: 'null' recurring_period: description: Payment frequency anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' number_of_occurrences: description: Total recurring payments anyOf: - anyOf: - type: number - type: string - type: 'null' periodRates: anyOf: - type: object properties: enabled: type: boolean periods: type: array items: type: object properties: periodNumber: type: number startOccurrence: type: number description: First occurrence this rate applies to endOccurrence: anyOf: - type: number - type: 'null' description: Last occurrence (null = unlimited) option: type: string enum: - fixed - percentage - scaling value: type: number scalingConfig: type: object properties: customFieldId: type: number description: >- Custom field whose value determines the tier tiers: type: array items: type: object properties: optionId: {} option: {} value: {} required: - optionId - option - value additionalProperties: false required: - customFieldId - tiers additionalProperties: false description: >- Scaling — commission varies based on a custom field option. required: - periodNumber - startOccurrence - endOccurrence - option - value additionalProperties: false required: - enabled - periods additionalProperties: false description: >- Variable rates per period range in recurring commissions. - type: 'null' additionalProperties: false description: Recurring payment component required: - oneOff - recurring additionalProperties: false additionalProperties: false required: - payment_stage_id - calculation additionalProperties: false description: >- A payment trigger — when a deal reaches this stage, the commission is calculated and applied. description: Payment triggers required: - entries additionalProperties: false description: >- Commission calculation with one or more payment entries triggered by deal stage changes. tiers: type: array items: type: object properties: uuid: type: string label: type: string required: - uuid - label additionalProperties: false categories: type: array items: type: object properties: uuid: type: string label: type: string required: - uuid - label additionalProperties: false partnerships: type: array items: type: object properties: uuid: type: string name: anyOf: - type: string - type: 'null' required: - uuid - name additionalProperties: false created_at: type: string updated_at: type: string required: - uuid - label - partner_type - payment_target - auto_assign_recipient - calculation - tiers - categories - partnerships - created_at - updated_at additionalProperties: false pagination: type: object properties: page: type: number per_page: type: number total: type: number total_pages: type: number required: - page - per_page - total - total_pages additionalProperties: false required: - data - pagination additionalProperties: false components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ````