> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firstpromoter.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get all commissions
> With this endpoint you can list all rewards and commissions assigned to a promotion, promoter, campaign or entire account using the API.
**HTTP Request**
`GET https://api.firstpromoter.com/api/v2/company/commissions`
## OpenAPI
````yaml openapi-v2-commissions get /commissions
openapi: 3.0.1
info:
title: FirstPromoter Commissions API
version: 2.0.0
description: API for managing commissions in FirstPromoter
servers:
- url: https://api.firstpromoter.com/api/v2/company
security:
- BearerAuth: []
paths:
/commissions:
get:
tags:
- Commissions
summary: Get all commissions
description: >-
With this endpoint you can list all rewards and commissions assigned to
a promotion, promoter, campaign or entire account using the API.
**HTTP Request**
`GET https://api.firstpromoter.com/api/v2/company/commissions`
parameters:
- $ref: '#/components/parameters/AccountId'
- name: q
in: query
description: Search params. Searches by event_id, referral.email, referral.uid
schema:
type: string
- name: ids[]
in: query
description: Array of commission ids to get
required: false
schema:
type: array
items:
type: integer
- name: filters
in: query
schema:
$ref: '#/components/schemas/CommissionFilters'
- name: sorting
in: query
schema:
$ref: '#/components/schemas/CommissionSorting'
responses:
'200':
description: Successfully retrieved commissions
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Commission'
'401':
description: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
parameters:
AccountId:
name: Account-ID
in: header
required: true
description: >-
Account id. You can find your Account ID on Your FirstPromoter
Dashboard. Navigate to Settings → Integrations
schema:
type: string
schemas:
CommissionFilters:
type: object
properties:
status:
type: string
enum:
- pending
- approved
- denied
paid:
type: string
enum:
- 'yes'
- 'no'
description: Paid filter for monetary commissions
fulfilled:
type: string
enum:
- 'yes'
- 'no'
description: Fulfilled filter for non-monetary commissions
sale_amount:
type: object
properties:
from:
type: integer
description: Sale amount from
to:
type: integer
description: Sale amount to
amount:
type: object
properties:
from:
type: integer
description: Amount from
to:
type: integer
description: Amount to
created_at:
type: object
properties:
from:
type: string
format: date
description: created_at start date
to:
type: string
format: date
description: created_at end date
campaign_id:
oneOf:
- type: integer
- type: array
items:
type: integer
description: Campaign ids. Can be Integer or Array of Integers
payout_id:
oneOf:
- type: integer
- type: array
items:
type: integer
description: Payout ids. Can be Integer or Array of Integers
due_period:
type: string
enum:
- next
- overdue
- custom
description: Due period filter
promoter_id:
type: integer
description: Promoter id
first_commission:
type: boolean
description: First commission
refunded:
type: boolean
description: Refunded reward
fraud_check:
type: string
enum:
- no_suspicion
- same_ip_suspicion
- same_promoter_email
- ad_source
description: Referral fraud check (suspicion). Array accepted
plan_id:
oneOf:
- type: integer
- type: array
items:
type: integer
description: Plan id
CommissionSorting:
type: object
properties:
sale_amount:
type: string
enum:
- asc
- desc
description: The sort by sale direction
amount:
type: string
enum:
- asc
- desc
description: The sort by amount direction
created_at:
type: string
enum:
- asc
- desc
description: The sort by created_at direction
referral:
type: string
enum:
- asc
- desc
description: The sort by referral direction
Commission:
type: object
properties:
id:
type: integer
description: Commission ID
status:
type: string
enum:
- pending
- approved
- denied
description: Current status of the commission
metadata:
type: object
description: Additional metadata about the commission
is_self_referral:
type: boolean
nullable: true
description: Whether this is a self-referral
commission_type:
type: string
enum:
- sale
- custom
description: Type of commission
created_by_user_email:
type: string
nullable: true
description: Email of the user who created the commission
created_by_user_at:
type: string
format: date-time
nullable: true
description: Timestamp when the user created the commission
sale_amount:
type: integer
description: Amount of the sale
original_sale_amount:
type: integer
description: Original amount of the sale
original_sale_currency:
type: string
nullable: true
description: Currency of the original sale
event_id:
type: string
nullable: true
description: ID of the event that generated the commission
plan_id:
type: string
nullable: true
description: Plan ID associated with the commission
tier:
type: integer
description: Reward tier
internal_note:
type: string
nullable: true
description: Internal note visible only to the team
external_note:
type: string
nullable: true
description: External note visible to the promoter
unit:
type: string
enum:
- cash
- credits
- points
- free_months
- mon_discount
- discount_per
description: Unit type for the reward
fraud_check:
type: string
nullable: true
enum:
- no_suspicion
- same_ip_suspicion
- same_promoter_email
- ad_source
description: Result of fraud check
amount:
type: integer
description: Commission amount
is_paid:
type: boolean
description: Whether the commission has been paid
is_split:
type: boolean
description: Whether the commission is split among multiple promoters
created_at:
type: string
format: date-time
description: Creation timestamp
status_updated_at:
type: string
format: date-time
nullable: true
description: Last status update timestamp
promoter_campaign:
type: object
properties:
id:
type: integer
description: Promoter campaign ID
campaign_id:
type: integer
description: Campaign ID
promoter_id:
type: integer
description: Promoter ID
created_at:
type: string
format: date-time
description: Creation timestamp
promoter:
type: object
properties:
id:
type: integer
description: Promoter ID
email:
type: string
description: Promoter email
name:
type: string
description: Promoter name
campaign:
type: object
properties:
id:
type: integer
description: Campaign ID
name:
type: string
description: Campaign name
color:
type: string
nullable: true
description: Campaign color
referral:
type: object
nullable: true
properties:
id:
type: integer
description: Referral ID
email:
type: string
description: Referral email
uid:
type: string
description: Referral UID
reward:
type: object
properties:
id:
type: integer
description: Reward ID
name:
type: string
description: Reward name
split_details:
type: object
nullable: true
description: >-
Commission split details from the associated referral, when the
referral is shared between promoters
ErrorResponse:
type: object
properties:
message:
type: string
description: Error message
code:
type: string
description: Error code
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: >-
API key passed as a Bearer token in the Authorization header. You can
find your API Key on Your FirstPromoter Dashboard. Navigate to Settings
→ Integrations section → Manage API Keys
````