GET
/
commissions
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/commissions \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "status": "pending",
    "metadata": {},
    "is_self_referral": true,
    "commission_type": "sale",
    "created_by_user_email": "<string>",
    "created_by_user_at": "2023-11-07T05:31:56Z",
    "sale_amount": 123,
    "original_sale_amount": 123,
    "original_sale_currency": "<string>",
    "event_id": "<string>",
    "plan_id": "<string>",
    "tier": 123,
    "internal_note": "<string>",
    "external_note": "<string>",
    "unit": "cash",
    "fraud_check": "no_suspicion",
    "amount": 123,
    "is_paid": true,
    "is_split": true,
    "created_at": "2023-11-07T05:31:56Z",
    "status_updated_at": "2023-11-07T05:31:56Z",
    "promoter_campaign": {
      "id": 123,
      "campaign_id": 123,
      "promoter_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "promoter": {
        "id": 123,
        "email": "<string>",
        "name": "<string>"
      },
      "campaign": {
        "id": 123,
        "name": "<string>",
        "color": "<string>"
      }
    },
    "referral": {
      "id": 123,
      "email": "<string>",
      "uid": "<string>"
    },
    "reward": {
      "id": 123,
      "name": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

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

Headers

​
Account-ID
string
required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Query Parameters

​
q
string

Search params. Searches by event_id, referral.email, referral.uid

​
ids[]
integer[]

Array of comission ids to get

​
filters
object
​
sorting
object

Response

200
application/json

Successfully retrieved commissions

The response is of type object[].