Get Affiliate - Chariow Developers

curl -X GET "https://api.chariow.com/v1/affiliates/CREATOR123" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "message": "Affiliate retrieved successfully",
  "data": {
    "id": "saff_xyz789abc",
    "status": "active",
    "source": {
      "label": "Invitation",
      "description": "Joined via invitation",
      "value": "invitation"
    },
    "total_visits": 150,
    "total_sales": 25,
    "total_earnings": {
      "value": 1250,
      "formatted": "$1,250.00",
      "short": "1.25K",
      "currency": "USD"
    },
    "first_visit_at": "2025-01-16T09:00:00+00:00",
    "last_visit_at": "2025-01-25T14:30:00+00:00",
    "suspended_at": null,
    "suspended_reason": null,
    "account": {
      "id": "aff_abc123def",
      "pseudo": "creative_studio",
      "country": {
        "code": "US",
        "name": "United States"
      },
      "status": "active",
      "user": {
        "name": "John Doe",
        "email": "john@example.com"
      },
      "created_at": "2025-01-15T10:30:00+00:00"
    },
    "created_at": "2025-01-15T10:30:00+00:00",
    "updated_at": "2025-01-25T14:30:00+00:00"
  },
  "errors": []
}

curl -X GET "https://api.chariow.com/v1/affiliates/CREATOR123" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "message": "Affiliate retrieved successfully",
  "data": {
    "id": "saff_xyz789abc",
    "status": "active",
    "source": {
      "label": "Invitation",
      "description": "Joined via invitation",
      "value": "invitation"
    },
    "total_visits": 150,
    "total_sales": 25,
    "total_earnings": {
      "value": 1250,
      "formatted": "$1,250.00",
      "short": "1.25K",
      "currency": "USD"
    },
    "first_visit_at": "2025-01-16T09:00:00+00:00",
    "last_visit_at": "2025-01-25T14:30:00+00:00",
    "suspended_at": null,
    "suspended_reason": null,
    "account": {
      "id": "aff_abc123def",
      "pseudo": "creative_studio",
      "country": {
        "code": "US",
        "name": "United States"
      },
      "status": "active",
      "user": {
        "name": "John Doe",
        "email": "john@example.com"
      },
      "created_at": "2025-01-15T10:30:00+00:00"
    },
    "created_at": "2025-01-15T10:30:00+00:00",
    "updated_at": "2025-01-25T14:30:00+00:00"
  },
  "errors": []
}

Retrieves detailed information about a specific affiliate by their unique affiliate code. This endpoint returns comprehensive affiliate information including their account details, performance statistics, and earnings.

Path Parameters

affiliateCode

string

required

The unique affiliate code (e.g., CREATOR123, PARTNER2025)

Response

message

string

Response status message

data

object

Show properties

string

Unique store affiliate identifier (e.g., saff_abc123xyz)

status

string

Affiliate status: active, inactive, or suspended

source

object

How the affiliate joined the store

Show source object

label

string

Human-readable label (e.g., Invitation, Application)

description

string

Description of the source

value

string

Source value: invitation, application, manual

total_visits

integer

Total number of visits through affiliate links

total_sales

integer

Total number of sales made through referrals

total_earnings

object

Total commission earnings

Show total_earnings object

value

integer

Earnings amount

formatted

string

Formatted earnings with currency symbol (e.g., $1,250.00)

short

string

Short formatted earnings (e.g., $1,250)

currency

string

Currency code (e.g., USD)

first_visit_at

string|null

ISO 8601 timestamp of first referral visit

last_visit_at

string|null

ISO 8601 timestamp of most recent referral visit

suspended_at

string|null

ISO 8601 timestamp when affiliate was suspended (if applicable)

suspended_reason

string|null

Reason for suspension (if applicable)

account

object

Affiliate account details

Show account object

string

Affiliate account public ID

pseudo

string

Affiliate’s display name/username

country

object

Affiliate’s country information

status

string

Account status

user

object

User details (name, email, etc.)

created_at

string

Account creation timestamp

created_at

string

ISO 8601 creation timestamp

updated_at

string

ISO 8601 last update timestamp

errors

array

Array of error messages (empty on success)

curl -X GET "https://api.chariow.com/v1/affiliates/CREATOR123" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "message": "Affiliate retrieved successfully",
  "data": {
    "id": "saff_xyz789abc",
    "status": "active",
    "source": {
      "label": "Invitation",
      "description": "Joined via invitation",
      "value": "invitation"
    },
    "total_visits": 150,
    "total_sales": 25,
    "total_earnings": {
      "value": 1250,
      "formatted": "$1,250.00",
      "short": "1.25K",
      "currency": "USD"
    },
    "first_visit_at": "2025-01-16T09:00:00+00:00",
    "last_visit_at": "2025-01-25T14:30:00+00:00",
    "suspended_at": null,
    "suspended_reason": null,
    "account": {
      "id": "aff_abc123def",
      "pseudo": "creative_studio",
      "country": {
        "code": "US",
        "name": "United States"
      },
      "status": "active",
      "user": {
        "name": "John Doe",
        "email": "john@example.com"
      },
      "created_at": "2025-01-15T10:30:00+00:00"
    },
    "created_at": "2025-01-15T10:30:00+00:00",
    "updated_at": "2025-01-25T14:30:00+00:00"
  },
  "errors": []
}

Get Pulse Send Affiliate Invitations

​Path Parameters

​Response

Path Parameters

Response