---
title: "Get referral"
method: GET
path: "/referrals/{id}"
tags: ["Referrals"]
---

# Get referral

`GET /referrals/{id}`

Get a specific referral 
 <Tip>**HTTP Request** <br/>`GET https://api.firstpromoter.com/api/v2/company/referrals/{id}`</Tip>

## Path parameters

- `id` string, required

## Query parameters

- `find_by` 'email' | 'uid' | 'username'

## Headers

- `Account-ID` string, required

## Response `200`

Referral details

- Referral
  - `id` integer — Id of the referral
  - `email` string, email — Email address of the referral
  - `uid` string — uid of the referral
  - `state` 'subscribed' | 'signup' | 'active' | 'cancelled' | 'refunded' | 'denied' | 'pending' | 'moved' — State of the referral
  - `metadata` object — Additional metadata of the referral
  - `entry_source` 'api' | 'coupon' | 'cookie' | 'manual_admin' | 'manual_affiliate' — Entry source of the referral. This shows where the referral was captured from. **Cookie** is set if the referral was captured using the tid cookie, **Coupon** is for when the referral is captured via a coupon code. **Manual admin** is for when the referral is added manually by an admin. **Manual affiliate** is for when the referral is added manually by an affiliate.
  - `created_at` string, date-time — Date and time when the referral was created
  - `customer_since` string, date-time, nullable — Date and time when the referral became a customer
  - `promoter_campaign` PromoterCampaign
    - `id` integer — Id of the promoter campaign
    - `campaign_id` integer — Id of the campaign
    - `promoter_id` integer — Id of the promoter
    - `created_at` string, date-time — Date and time when the promoter campaign was created
    - `promoter` Promoter
      - `id` integer — ID of the promoter
      - `status` string — Status of the promoter
      - `cust_id` string
      - `email` string — Email of the promoter
      - `created_at` string, date-time — ISO date of when the promoter was created
      - `temp_password` string, nullable — Temporary password created for the promoter
      - `default_promotion_id` integer
      - `pref` string
      - `default_ref_id` string — Default referral id of the promoter
      - `note` string, nullable — A note/description of promoter
      - `w8_form_url` string, nullable — Url of the w8 form
      - `w9_form_url` string, nullable — Url of the w9 form
      - `parent_promoter_id` integer — Parent promoter id
      - `earnings_balance` object — Earning balance of the promoter
        - `cash` integer
      - `current_balance` object — Current balance of the promoter
        - `cash` integer
      - `paid_balance` object — Paid balance of the promoter
        - `cash` integer
      - `auth_token` string — Authentication token generated when the promoter was created
    - `campaign` Campaign
      - `id` integer — Id of the campaign
      - `name` string — Name of the campaign
      - `color` string, nullable — Color assigned to the campaign
  - `fraud_check` 'no_suspicion' | 'same_ip_suspicion' | 'same_promoter_email' | 'ad_source' — Fraud check (suspicion) status of the referral. `no_suspicion` means the referral is clean or was manually cleared. `same_ip_suspicion` means the referral shares an IP with the promoter. `same_promoter_email` means the referral email matches the promoter email. `ad_source` means the referral arrived via a paid ad click.
  - `created_by_user_email` string, email, nullable — Email address of the user who created the referral
  - `username` string, nullable — Username chosen by the referral
  - `split_details` object[], nullable — The commission split configuration for this referral. Each entry represents a split partner. The primary promoter (the referral owner) receives the remainder of the commission after all split percentages are applied.
    - `promoter_campaign_id` integer — The ID of the split partner's campaign enrollment
    - `promoter_id` integer — The ID of the split partner (promoter)
    - `percentage` integer — The percentage of each commission this promoter receives
  - `first_name` string, nullable
  - `last_name` string, nullable
  - `website` string, nullable
  - `comment` string, nullable — Internal note or comment on this referral
  - `is_expired` boolean — Whether the referral has expired

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found

---

[API](https://skmtc.net/firstpromoter/apis/firstpromoter-batch-processes-api.md) · [All operations](https://skmtc.net/firstpromoter/apis/firstpromoter-batch-processes-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firstpromoter/firstpromoter-batch-processes-api/versions/e15f0d026ccf/schema)