{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/highlevel/json-schema/highlevel-list-affiliates-response-dto-schema.json",
  "title": "ListAffiliatesResponseDto",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/highlevel-affiliates-api-openapi.yml#/components/schemas/ListAffiliatesResponseDto",
  "type": "object",
  "properties": {
    "affiliates": {
      "description": "Affiliate list",
      "type": "array",
      "items": {
        "$ref": "#/$defs/OAuthAffiliateListItemResponseDto"
      }
    },
    "meta": {
      "description": "Pagination metadata",
      "allOf": [
        {
          "$ref": "#/$defs/AffiliateListMetaResponseDto"
        }
      ]
    }
  },
  "required": [
    "affiliates",
    "meta"
  ],
  "$defs": {
    "AffiliateListMetaResponseDto": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number",
          "description": "Total affiliates matching the applied filters"
        }
      },
      "required": [
        "count"
      ]
    },
    "OAuthAffiliateListItemResponseDto": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "Affiliate id"
        },
        "firstName": {
          "type": "string",
          "description": "Affiliate first name"
        },
        "lastName": {
          "type": "string",
          "description": "Affiliate last name"
        },
        "phone": {
          "type": "string",
          "description": "Affiliate phone number"
        },
        "deleted": {
          "type": "boolean",
          "description": "Whether the affiliate is deleted"
        },
        "locationId": {
          "type": "string",
          "description": "Location id"
        },
        "active": {
          "type": "boolean",
          "description": "Whether the affiliate is active"
        },
        "address": {
          "type": "string",
          "description": "Affiliate address"
        },
        "avatar": {
          "type": "string",
          "description": "Affiliate avatar URL"
        },
        "createdAt": {
          "type": "string",
          "description": "Created at timestamp"
        },
        "createdBy": {
          "type": "object",
          "description": "Created by audit info"
        },
        "facebookUrl": {
          "type": "string",
          "description": "Facebook URL"
        },
        "instagramUrl": {
          "type": "string",
          "description": "Instagram URL"
        },
        "linkedInUrl": {
          "type": "string",
          "description": "LinkedIn URL"
        },
        "twitterUrl": {
          "type": "string",
          "description": "Twitter URL"
        },
        "youtubeUrl": {
          "type": "string",
          "description": "YouTube URL"
        },
        "websiteUrl": {
          "type": "string",
          "description": "Website URL"
        },
        "contactId": {
          "type": "string",
          "description": "Contact id associated with the affiliate"
        },
        "campaignIds": {
          "description": "Campaign ids",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "vatId": {
          "type": "string",
          "description": "VAT ID"
        },
        "updatedAt": {
          "type": "string",
          "description": "Updated at timestamp"
        },
        "w8Form": {
          "type": "string",
          "description": "W8 form URL"
        },
        "w9Form": {
          "type": "string",
          "description": "W9 form URL"
        },
        "lastUpdatedBy": {
          "type": "object",
          "description": "Last updated by audit info"
        },
        "email": {
          "type": "string",
          "description": "Affiliate email"
        },
        "revenue": {
          "type": "number",
          "description": "Affiliate revenue"
        },
        "customer": {
          "type": "number",
          "description": "Customer count"
        },
        "lead": {
          "type": "number",
          "description": "Lead count"
        },
        "droppedCustomer": {
          "type": "number",
          "description": "Dropped customer count"
        },
        "clickCount": {
          "type": "number",
          "description": "Click count"
        },
        "paid": {
          "type": "number",
          "description": "Paid amount"
        },
        "currency": {
          "type": "string",
          "description": "Currency code"
        },
        "owned": {
          "type": "number",
          "description": "Owned amount"
        }
      },
      "required": [
        "_id",
        "locationId",
        "email"
      ]
    }
  }
}