HighLevel: List Payouts

← Affiliate manager operations · Get started

Operation gohighlevel.list_payouts

Provider route: GET /affiliate-manager/{locationId}/payouts. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["affiliateManager"]["listPayouts"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.affiliateManager.listPayouts(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.affiliate_manager.list_payouts(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.locationId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.status	string	Optional
query.query	string	Optional
query.affiliateId	string	Optional
query.campaignId	string	Optional
query.skip	number	Optional	Default: 0
query.limit	number	Optional	Default: 10
query.start	string	Optional
query.end	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List Payouts — response body

Referenced models: List Payouts — response body

Schemas

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 — 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

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]+)?$

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

Policy, approvals and errors

SDK function policy ID: gohighlevel.list_payouts. Catalog operation: list-payouts. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["affiliate-manager.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source