Get Affiliates - SweetRef

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

page

integer

optional

Example:

1

per_page

integer

optional

Example:

25

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

data

array[object (Affiliate) {20}]

required

id

string

required

The unique identifier of the affiliate program.

code

string

required

The code assigned to the affiliate.

conversions_count

integer

optional

The number of conversions the affiliate has generated.

created_at

string <date-time>

optional

The date and time when the affiliate was created.

email

string <email>

required

The email address of the affiliate.

first_name

string

required

The first name of the affiliate.

last_name

string

required

The last name of the affiliate.

payouts_count

integer

optional

The number of payouts made to the affiliate.

paypal_email

string <email>

optional

The PayPal email address of the affiliate.

referrals_count

integer

optional

The number of referrals the affiliate has generated.

signups_count

integer

optional

The number of signups the affiliate has generated.

source

string

optional

The source from which the affiliate was generated.

status

enum<string>

required

The current status of the affiliate.

Allowed values:

pendingapprovedrejected

total_commission_cents

integer

optional

The total commission earned by the affiliate in cents.

total_payout_cents

integer

optional

The total payouts made to the affiliate in cents.

total_profit_cents

integer

optional

The total profit earned by the affiliate in cents.

total_revenue_cents

integer

optional

The total revenue generated by the affiliate in cents.

updated_at

string <date-time>

optional

The date and time when the affiliate information was last updated.

visits_count

integer

optional

The number of visits generated by the affiliate.

wise_email

string <email>

optional

The Wise (TransferWise) email address of the affiliate.

meta

object (Pagination Metadata)

required

total_pages

integer

required

total_count

integer

required

current_page

integer

required

Example

{
  "data": [
    {
      "id": "string",
      "code": "string",
      "conversions_count": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "email": "user@example.com",
      "first_name": "string",
      "last_name": "string",
      "payouts_count": 0,
      "paypal_email": "user@example.com",
      "referrals_count": 0,
      "signups_count": 0,
      "source": "string",
      "status": "pending",
      "total_commission_cents": 0,
      "total_payout_cents": 0,
      "total_profit_cents": 0,
      "total_revenue_cents": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "visits_count": 0,
      "wise_email": "user@example.com"
    }
  ],
  "meta": {
    "total_pages": 0,
    "total_count": 0,
    "current_page": 0
  }
}