SweetRef
HomeLink
Multiple Menus
  • Link1
  • Link2
HomeLink
Multiple Menus
  • Link1
  • Link2
  1. Affiliates
  • Get Started
  • Webhooks
  • API
    • Affiliates
      • Get Affiliates
        GET
      • Find Affiliate by ID
        GET
      • Get Affiliate Referrals
        GET
    • Referrals
      • Get Referrals
      • Get Referral By ID
    • Referral Payments
      • Get Referrals Payments
      • Get Referral Payment By ID
    • Get Program Information
      GET
  1. Affiliates

Find Affiliate by ID

Prod Env
https://api.sweetref.com
Prod Env
https://api.sweetref.com
GET
/affiliates/{id}
affiliates

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required
Example:
ap_kgoLDRy3J9DkluA4pYmrdW2V

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.sweetref.com/affiliates/ap_kgoLDRy3J9DkluA4pYmrdW2V'

Responses

🟢200OK
application/json
Body
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.
Example
{
    "id": "ap_kgoLDRy3J9DkluA4pYmrdW2V",
    "code": "DJ0ASLVZ",
    "conversions_count": 0,
    "created_at": "2024-08-09 00:00:00 UTC",
    "email": "aff0@aff.com",
    "first_name": "Maximo",
    "last_name": "Bednar",
    "payouts_count": 25,
    "paypal_email": "aff0@aff.com",
    "referrals_count": 8,
    "signups_count": 0,
    "source": "program_page",
    "status": "pending",
    "total_commission_cents": 383430,
    "total_payout_cents": 1156300,
    "total_profit_cents": 894670,
    "total_revenue_cents": 1278100,
    "updated_at": "2024-08-09 15:34:17 UTC",
    "visits_count": 1,
    "wise_email": "aff0@aff.com"
}
🟠404Record not found
🟠400Invalid input
Modified at 2024-11-10 14:57:57
Previous
Get Affiliates
Next
Get Affiliate Referrals
Built with