GET
/
promoters
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/promoters \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "email": "<string>",
    "name": "<string>",
    "cust_id": "<string>",
    "note": "<string>",
    "state": "pending",
    "stats": {
      "clicks_count": 123,
      "referrals_count": 123,
      "sales_count": 123,
      "customers_count": 123,
      "revenue_amount": 123,
      "active_customers_count": 123
    },
    "is_customized": true,
    "fraud_suspicions": [
      "<string>"
    ],
    "is_confirmed": true,
    "invoice_details_status": "pending",
    "profile": {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "website": "<string>",
      "company_name": "<string>",
      "company_number": "<string>",
      "phone_number": "<string>",
      "vat_id": "<string>",
      "country": "US",
      "address": "<string>",
      "paypal_email": "<string>",
      "avatar": "<string>",
      "w8_form_url": "<string>",
      "w9_form_url": "<string>",
      "description": "<string>",
      "invoice_details_validation_errors": {},
      "should_validate_invoice_details": true,
      "instagram_url": "<string>",
      "youtube_url": "<string>",
      "linkedin_url": "<string>",
      "facebook_url": "<string>",
      "twitter_url": "<string>",
      "twitch_url": "<string>",
      "tiktok_url": "<string>"
    },
    "joined_at": "2023-11-07T05:31:56Z",
    "last_login_at": "2023-11-07T05:31:56Z",
    "archived_at": "2023-11-07T05:31:56Z",
    "first_event_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "promoter_campaigns": [
      {
        "id": 123,
        "campaign_id": 123,
        "promoter_id": 123,
        "state": "pending",
        "created_at": "2023-11-07T05:31:56Z",
        "campaign": {
          "id": 123,
          "name": "<string>",
          "color": "<string>"
        },
        "coupon": "<string>",
        "ref_token": "<string>",
        "ref_link": "<string>"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

​
Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Query Parameters

​
q
string

Search params for promoters, search using, email, name or ref_id

​
ids[]
integer[]

Array of promoter ids to get

​
filters
object

Filter params

​
sorting
object

Sorting params

Response

200
application/json
Successful response

The response is of type object[].