Get Affiliate

GET 
/affiliate-manager/:locationId/affiliates/:affiliateId

Retrieve a single affiliate by id for a location.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

affiliateId stringrequired

Affiliate Id

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Affiliate id

firstNamestring

Affiliate first name

lastNamestring

Affiliate last name

phonestring

Affiliate phone number

deletedboolean

Whether the affiliate is deleted

locationIdstringrequired

Location id

activeboolean

Whether the affiliate is active

addressstring

Affiliate address

avatarstring

Affiliate avatar URL

createdAtstring

Created at timestamp

createdByobject

Created by audit info

facebookUrlstring

Facebook URL

instagramUrlstring

Instagram URL

linkedInUrlstring

LinkedIn URL

twitterUrlstring

Twitter URL

youtubeUrlstring

YouTube URL

websiteUrlstring

Website URL

contactIdstring

Contact id associated with the affiliate

campaignIdsstring[]

Campaign ids

vatIdstring

VAT ID

updatedAtstring

Updated at timestamp

w8Formstring

W8 form URL

w9Formstring

W9 form URL

lastUpdatedByobject

Last updated by audit info

emailstringrequired

Affiliate email

revenuenumber

Affiliate revenue

customernumber

Customer count

leadnumber

Lead count

droppedCustomernumber

Dropped customer count

clickCountnumber

Click count

paidnumber

Paid amount

currencystring

Currency code

ownednumber

Owned amount

Example (auto)

{
  "_id": "63d147176c5bbc30e9e091a4",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1 888 888-8888",
  "deleted": false,
  "locationId": "ve9EPM428h8vShlRW1KT",
  "active": true,
  "address": "123 Main St",
  "avatar": "https://example.com/avatar.png",
  "createdAt": "2024-06-16T00:00:00.000Z",
  "createdBy": {},
  "facebookUrl": "https://facebook.com/johndoe",
  "instagramUrl": "https://instagram.com/johndoe",
  "linkedInUrl": "https://linkedin.com/in/johndoe",
  "twitterUrl": "https://twitter.com/johndoe",
  "youtubeUrl": "https://youtube.com/channel",
  "websiteUrl": "https://example.com",
  "contactId": "ve9EPM428h8vShlRW1KT",
  "campaignIds": [
    "650173614761b33c46d33b19"
  ],
  "vatId": "VAT123",
  "updatedAt": "2024-06-16T00:00:00.000Z",
  "w8Form": "string",
  "w9Form": "string",
  "lastUpdatedBy": {},
  "email": "[email protected]",
  "revenue": 1250.5,
  "customer": 15,
  "lead": 5,
  "droppedCustomer": 2,
  "clickCount": 100,
  "paid": 500,
  "currency": "USD",
  "owned": 750
}