HighLevel: List Commissions

← Affiliate manager operations · Get started

Operation gohighlevel.list_commissions

Provider route: GET /affiliate-manager/{locationId}/commissions. 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"]["listCommissions"]>[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.listCommissions(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_commissions(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.campaignId	string	Optional
query.affiliateId	string	Optional
query.status	string	Optional
query.query	string	Optional
query.skip	number	Optional	Default: 0
query.limit	number	Optional	Default: 10
query.fromDate	string	Optional
query.toDate	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 Commissions — response body

Referenced models: List Commissions — response body

Schemas

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

Policy, approvals and errors

SDK function policy ID: gohighlevel.list_commissions. Catalog operation: list-commissions. 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