HighLevel: Affiliate manager schemas

← Affiliate manager operations · All schemas

Get Affiliate — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Affiliate id
active	boolean	Optional	Whether the affiliate is active
address	string	Optional	Affiliate address
avatar	string	Optional	Affiliate avatar URL
campaignIds	array	Optional	Campaign ids
campaignIds[]	string	Each item
clickCount	JSON	Optional
clickCount (anyOf 1)	number	Alternative	Click count
clickCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contactId	string	Optional	Contact id associated with the affiliate
createdAt	string	Optional	Created at timestamp
createdBy	object	Optional	Created by audit info
currency	string	Optional	Currency code
customer	JSON	Optional
customer (anyOf 1)	number	Alternative	Customer count
customer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deleted	boolean	Optional	Whether the affiliate is deleted
droppedCustomer	JSON	Optional
droppedCustomer (anyOf 1)	number	Alternative	Dropped customer count
droppedCustomer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
email	string	Required within parent	Affiliate email
facebookUrl	string	Optional	Facebook URL
firstName	string	Optional	Affiliate first name
instagramUrl	string	Optional	Instagram URL
lastName	string	Optional	Affiliate last name
lastUpdatedBy	object	Optional	Last updated by audit info
lead	JSON	Optional
lead (anyOf 1)	number	Alternative	Lead count
lead (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
linkedInUrl	string	Optional	LinkedIn URL
locationId	string	Required within parent	Location id
owned	JSON	Optional
owned (anyOf 1)	number	Alternative	Owned amount
owned (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
paid	JSON	Optional
paid (anyOf 1)	number	Alternative	Paid amount
paid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
phone	string	Optional	Affiliate phone number
revenue	JSON	Optional
revenue (anyOf 1)	number	Alternative	Affiliate revenue
revenue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
twitterUrl	string	Optional	Twitter URL
updatedAt	string	Optional	Updated at timestamp
vatId	string	Optional	VAT ID
w8Form	string	Optional	W8 form URL
w9Form	string	Optional	W9 form URL
websiteUrl	string	Optional	Website URL
youtubeUrl	string	Optional	YouTube URL

List Affiliates — response body

Field	Type	Presence	Description and constraints
$	object	Root
affiliates	array	Required within parent	Affiliate list
affiliates[]	Model	Each item	Expand Get Affiliate — response body
meta	JSON	Required within parent	Pagination metadata
meta (allOf 1)	Model	All variants apply	Expand List Affiliates — response body — meta count

Referenced models: List Affiliates — response body — meta count, Get Affiliate — response body

List Affiliates — response body — meta count

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Total affiliates matching the applied filters
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Commissions — response body

Field	Type	Presence	Description and constraints
$	object	Root
commissions	array	Required within parent	Commission list
commissions[]	Model	Each item	Expand List Commissions — response body — commissions item
meta	JSON	Optional	Pagination metadata
meta (allOf 1)	Model	All variants apply	Expand List Commissions — response body — meta count

Referenced models: List Commissions — response body — commissions item, List Commissions — response body — meta count

List Commissions — response body — commissions item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Commission id
affiliate	JSON	Optional	Affiliate details
affiliate (allOf 1)	Model	All variants apply	Expand List Commissions — response body — commissions item affiliate id, email, name
affiliateId	string	Optional	Affiliate id
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Base amount
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
campaign	JSON	Optional	Campaign details
campaign (allOf 1)	Model	All variants apply	Expand List Commissions — response body — commissions item campaign id, live Mode, name
campaignName	string	Optional	Campaign name
commission	JSON	Optional
commission (anyOf 1)	number	Alternative	Commission percentage or value
commission (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
commissionAmount	JSON	Optional
commissionAmount (anyOf 1)	number	Alternative	Commission amount
commissionAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
commissionType	string	Optional	Commission type
createdAt	string	Optional	Created at
currency	string	Optional	Currency
customer	JSON	Optional	Customer details
customer (allOf 1)	Model	All variants apply	Expand List Commissions — response body — commissions item customer id, email, first Name, last Name, type
dueAt	string	Optional	Due date
eventId	string	Optional	Event id
isTrial	boolean	Optional	Whether the item is a trial commission
liveMode	boolean	Optional	Whether the commission is in live mode
payoutId	string	Optional	Payout id
productCommission	JSON	Optional
productCommission (anyOf 1)	number	Alternative	Product commission amount
productCommission (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
productId	string	Optional	Product id
productName	string	Optional	Product name
qty	JSON	Optional
qty (anyOf 1)	number	Alternative	Quantity
qty (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
status	string	Optional	Commission status
tier	JSON	Optional
tier (anyOf 1)	number	Alternative	Commission tier
tier (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
transactionAt	string	Optional	Transaction time
transactionId	string	Optional	Transaction id
unitDiscount	JSON	Optional
unitDiscount (anyOf 1)	number	Alternative	Unit discount
unitDiscount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Commissions — response body — commissions item affiliate id, email, name, List Commissions — response body — commissions item campaign id, live Mode, name, List Commissions — response body — commissions item customer id, email, first Name, last Name, type

List Commissions — response body — commissions item affiliate id, email, name

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Affiliate id
email	string	Optional	Affiliate email
name	string	Optional	Affiliate display name

List Commissions — response body — commissions item campaign id, live Mode, name

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Campaign id
liveMode	boolean	Optional	Whether the campaign is in live mode
name	string	Optional	Campaign name

List Commissions — response body — commissions item customer id, email, first Name, last Name, type

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Customer id
email	string	Optional	Customer email
firstName	string	Optional	Customer first name
lastName	string	Optional	Customer last name
type	string	Optional	Customer type

List Commissions — response body — meta count

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Total commissions matching the filters
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Payouts — response body

Field	Type	Presence	Description and constraints
$	object	Root
meta	JSON	Optional	Pagination metadata
meta (allOf 1)	Model	All variants apply	Expand List Payouts — response body — meta count
payouts	array	Required within parent	Payout list
payouts[]	Model	Each item	Expand List Payouts — response body — payouts item

Referenced models: List Payouts — response body — payouts item, List Payouts — response body — meta count

List Payouts — response body — meta count

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Total payouts matching the filters
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Payouts — response body — payouts item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Payout id
affiliate	JSON	Optional	Affiliate details
affiliate (allOf 1)	Model	All variants apply	Expand Get Affiliate — response body
affiliateEmail	string	Optional	Affiliate email
affiliateId	string	Required within parent	Affiliate id
affiliateName	string	Optional	Affiliate display name
altId	string	Optional	Alternate id
amount	JSON	Required within parent
amount (anyOf 1)	number	Alternative	Payout amount
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
campaign	string	Optional	Campaign name
campaignId	string	Optional	Campaign id
createdAt	string	Optional	Created at timestamp
currency	string	Required within parent	Payout currency
deleted	boolean	Optional	Whether the payout is deleted
dueAt	string	Optional	Payout due date
isMigrated	boolean	Optional	Whether the payout is migrated
locationId	string	Required within parent	Location id
paidAt	string	Optional	Payout paid date
paidMeta	object	Optional	Payout metadata
paidMethod	string	Optional	Payout paid method
payoutMethod	string	Optional	Primary payout method
payoutMonth	string	Optional	Payout month
status	string	Optional	Payout status
updatedAt	string	Optional	Updated at timestamp

Referenced models: Get Affiliate — response body