List Affiliates

200 - Successful response

object[]

required

Affiliate list

Show cada item

string

default:"63d147176c5bbc30e9e091a4"

required

Affiliate id

string

default:"John"

Affiliate first name

string

default:"Doe"

Affiliate last name

string

default:"+1 888 888-8888"

Affiliate phone number

boolean

default:"False"

Whether the affiliate is deleted

string

default:"ve9EPM428h8vShlRW1KT"

required

Account id

boolean

default:"True"

Whether the affiliate is active

string

default:"123 Main St"

Affiliate address

string

default:"https://example.com/avatar.png"

Affiliate avatar URL

string

default:"2024-06-16T00:00:00.000Z"

Created at timestamp

object

Created by audit info

string

default:"https://facebook.com/johndoe"

Facebook URL

string

default:"https://instagram.com/johndoe"

Instagram URL

string

default:"https://linkedin.com/in/johndoe"

LinkedIn URL

string

default:"https://twitter.com/johndoe"

Twitter URL

string

default:"https://youtube.com/channel"

YouTube URL

string

default:"https://example.com"

Website URL

string

default:"ve9EPM428h8vShlRW1KT"

Contact id associated with the affiliate

string[]

Campaign ids

string

default:"VAT123"

VAT ID

string

default:"2024-06-16T00:00:00.000Z"

Updated at timestamp

string

W8 form URL

string

W9 form URL

object

Last updated by audit info

string

default:"john.doe@example.com"

required

Affiliate email

number

default:"1250.5"

Affiliate revenue

number

default:"15"

Customer count

number

default:"5"

Lead count

number

default:"2"

Dropped customer count

number

default:"100"

Click count

number

default:"500"

Paid amount

string

default:"USD"

Currency code

number

default:"750"

Owned amount

object

required

Pagination metadata

{
  "affiliates": [
    {
      "_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": "john.doe@example.com",
      "revenue": 1250.5,
      "customer": 15,
      "lead": 5,
      "droppedCustomer": 2,
      "clickCount": 100,
      "paid": 500,
      "currency": "USD",
      "owned": 750
    }
  // truncado: 2 lineas mas
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Empezar

Scopes

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo

​Autorización

​Path parameters

​Query parameters

​Respuestas

​Ejemplo

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo