# List Payouts GET https://services.leadconnectorhq.com/affiliate-manager/payouts Retrieve the list of payouts for a location. ## Authentication Send `Authorization: Bearer ` using any one of: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `affiliate-manager.readonly` - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `affiliate-manager.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `status` | string | No | Payout Status | | `inFlight` | boolean | No | Filter by whether a payment gateway is still working on the payout. true drives the Processing tab; false excludes in-flight rows from Approved and Paid. Omit for the previous behaviour of no filter. | | `query` | string | No | query | | `affiliateId` | string | No | Affiliate Id | | `campaignId` | string | No | Campaign Id | | `skip` | number | No | Number of records to skip for pagination | | `limit` | number | No | Maximum number of records to return | | `start` | string | No | Filter payouts on or after this date (ISO 8601) | | `end` | string | No | Filter payouts on or before this date (ISO 8601) | | `locationId` | string | Yes | Location Id | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "HighLevel API", "version": "v4" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/affiliate-manager/payouts": { "get": { "summary": "List Payouts", "operationId": "listPayouts", "description": "Retrieve the list of payouts for a location.", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v4" ] } }, { "name": "status", "required": false, "in": "query", "description": "Payout Status", "schema": { "type": "string", "enum": [ "pending", "approved", "paid", "denied", "canceled", "payment_failed" ], "title": "Payout Status" } }, { "name": "inFlight", "required": false, "in": "query", "description": "Filter by whether a payment gateway is still working on the payout. true drives the Processing tab; false excludes in-flight rows from Approved and Paid. Omit for the previous behaviour of no filter.", "schema": { "example": true, "type": "boolean" } }, { "name": "query", "required": false, "in": "query", "description": "query", "schema": { "example": "john", "type": "string" } }, { "name": "affiliateId", "required": false, "in": "query", "description": "Affiliate Id", "schema": { "example": "65df04201e428a0c5ebb6572", "type": "string" } }, { "name": "campaignId", "required": false, "in": "query", "description": "Campaign Id", "schema": { "example": "65df04201e428a0c5ebb6573", "type": "string" } }, { "name": "skip", "required": false, "in": "query", "description": "Number of records to skip for pagination", "schema": { "default": 0, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Maximum number of records to return", "schema": { "default": 10, "example": 10, "type": "number" } }, { "name": "start", "required": false, "in": "query", "description": "Filter payouts on or after this date (ISO 8601)", "schema": { "example": "2022-12-01T00:00:00.000Z", "type": "string" } }, { "name": "end", "required": false, "in": "query", "description": "Filter payouts on or before this date (ISO 8601)", "schema": { "example": "2022-12-31T23:59:59.999Z", "type": "string" } }, { "name": "locationId", "required": true, "in": "query", "description": "Location Id", "schema": { "example": "ve9EPM428h8vShlRW1KT", "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayoutListResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "403": { "description": "Forbidden" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "bearer": [ "affiliate-manager.readonly" ] }, { "Location-Access": [ "affiliate-manager.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "GetPayoutListResponseDto": { "type": "object", "properties": { "payouts": { "description": "Payout list", "example": [ { "_id": "69c0ee71c501d6b731110028", "locationId": "Lx1EI6YIgQYMQi0ytFXv", "affiliateId": "6792254b535e27b9ab02be63", "campaignId": "695e70357e5c8d108c41d160", "currency": "USD", "amount": 700, "status": "pending", "payoutMonth": "2026-06-01T00:00:00.000Z", "dueAt": "2026-06-29T00:00:00.000Z", "paidMethod": "manual", "deleted": false, "createdAt": "2026-03-23T07:40:33.034Z", "updatedAt": "2026-03-23T09:18:03.320Z", "affiliate": { "_id": "6792254b535e27b9ab02be63", "firstName": "John", "lastName": "Deo", "phone": "+915979490952", "deleted": false, "locationId": "Lx1EI6YIgQYMQi0ytFXv", "active": true, "createdAt": "2025-01-23T11:17:31.157Z", "contactId": "3gLOpQH8ESSPpHW3JUAn" }, "campaign": "New Invite Flow", "affiliateName": "John Deo", "affiliateEmail": "johndeo@gmail.com", "payoutMethod": "PAYPAL" } ], "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "description": "Payout id", "example": "65df04201e428a0c5ebb6571" }, "locationId": { "type": "string", "description": "Location id", "example": "ve9EPM428h8vShlRW1KT" }, "affiliateId": { "type": "string", "description": "Affiliate id", "example": "65df04201e428a0c5ebb6572" }, "campaignId": { "type": "string", "description": "Campaign id", "example": "65df04201e428a0c5ebb6573" }, "currency": { "type": "string", "description": "Payout currency", "example": "USD" }, "amount": { "type": "number", "description": "Payout amount", "example": 150 }, "status": { "type": "string", "description": "Payout status. `payment_failed` is new: approved, attempted, and declined by the gateway.", "enum": [ "pending", "approved", "paid", "denied", "canceled", "payment_failed" ], "example": "pending" }, "payoutMonth": { "type": "string", "description": "Payout month", "example": "2024-06-01T00:00:00.000Z" }, "dueAt": { "type": "string", "description": "Payout due date", "example": "2024-06-30T00:00:00.000Z" }, "paidAt": { "type": "string", "description": "Payout paid date", "example": "2024-06-30T00:00:00.000Z" }, "paidMeta": { "type": "object", "description": "Payout metadata", "example": { "paidBy": { "source": "WEB_USER", "channel": "APP", "sourceId": "hxHGVRb1YJUscrCB8eXK", "sourceName": "John Deo", "timestamp": "Tue Mar 31 2026 04:50:47 GMT+0000" }, "paymentMode": "test", "payoutBatchId": "A8K4MCH3ZFVVU", "payoutItemId": "EY4K5APF2PUXE", "transactionId": "86S70255S66320927", "activityId": "1Y42411261716960J", "status": "UNCLAIMED", "payoutItemFee": { "currency": "USD", "value": "0.25" }, "payoutItem": { "recipientType": "EMAIL", "amount": { "currency": "USD", "value": "2.50" }, "receiver": "johndeo@gmail.com", "receiverWallet": "PAYPAL", "senderItemId": "LC_PAYOUT_69cb528b2f33ea3d05fe64cc" } } }, "paidMethod": { "type": "string", "description": "Payout paid method", "example": "manual" }, "altId": { "type": "string", "description": "Alternate id", "example": "alt_123" }, "deleted": { "type": "boolean", "description": "Whether the payout is deleted", "example": false }, "isMigrated": { "type": "boolean", "description": "Whether the payout is migrated", "example": false }, "createdAt": { "type": "string", "description": "Created at timestamp", "example": "2024-06-16T00:00:00.000Z" }, "updatedAt": { "type": "string", "description": "Updated at timestamp", "example": "2024-06-17T00:00:00.000Z" }, "campaign": { "type": "string", "description": "Campaign name", "example": "Summer Promo" }, "affiliateName": { "type": "string", "description": "Affiliate display name", "example": "John Doe" }, "affiliateEmail": { "type": "string", "description": "Affiliate email", "example": "john.doe@example.com" }, "payoutMethod": { "type": "string", "description": "Primary payout method", "example": "paypal" }, "affiliate": { "description": "Affiliate details", "allOf": [ { "type": "object", "properties": { "_id": { "type": "string", "description": "Affiliate id", "example": "63d147176c5bbc30e9e091a4" }, "firstName": { "type": "string", "description": "Affiliate first name", "example": "John" }, "lastName": { "type": "string", "description": "Affiliate last name", "example": "Doe" }, "phone": { "type": "string", "description": "Affiliate phone number", "example": "+1 888 888-8888" }, "deleted": { "type": "boolean", "description": "Whether the affiliate is deleted", "example": false }, "locationId": { "type": "string", "description": "Location id", "example": "ve9EPM428h8vShlRW1KT" }, "active": { "type": "boolean", "description": "Whether the affiliate is active", "example": true }, "address": { "type": "string", "description": "Affiliate address", "example": "123 Main St" }, "avatar": { "type": "string", "description": "Affiliate avatar URL", "example": "https://example.com/avatar.png" }, "createdAt": { "type": "string", "description": "Created at timestamp", "example": "2024-06-16T00:00:00.000Z" }, "createdBy": { "description": "Who created the affiliate", "allOf": [ { "type": "object", "properties": { "source": { "type": "string", "description": "Source of the action", "example": "oauth" }, "channel": { "type": "string", "description": "Channel of the action", "example": "oauth" }, "sourceId": { "type": "string", "description": "Source id of the actor", "example": "source_123" }, "sourceName": { "type": "string", "description": "Source name of the actor", "example": "Marketplace App" }, "timestamp": { "type": "string", "description": "Timestamp when the action happened", "example": "2024-06-16T00:00:00.000Z" } }, "title": "AffiliateAuditResponseDto" } ] }, "facebookUrl": { "type": "string", "description": "Facebook URL", "example": "https://facebook.com/johndoe" }, "instagramUrl": { "type": "string", "description": "Instagram URL", "example": "https://instagram.com/johndoe" }, "linkedInUrl": { "type": "string", "description": "LinkedIn URL", "example": "https://linkedin.com/in/johndoe" }, "twitterUrl": { "type": "string", "description": "Twitter URL", "example": "https://twitter.com/johndoe" }, "youtubeUrl": { "type": "string", "description": "YouTube URL", "example": "https://youtube.com/channel" }, "websiteUrl": { "type": "string", "description": "Website URL", "example": "https://example.com" }, "contactId": { "type": "string", "description": "Contact id associated with the affiliate", "example": "ve9EPM428h8vShlRW1KT" }, "campaignIds": { "description": "Campaign ids", "example": [ "650173614761b33c46d33b19" ], "type": "array", "items": { "type": "string" } }, "vatId": { "type": "string", "description": "VAT ID", "example": "VAT123" }, "updatedAt": { "type": "string", "description": "Updated at timestamp", "example": "2024-06-16T00:00:00.000Z" }, "w8Form": { "type": "string", "description": "W-8 form URL", "example": "https://example.com/tax-forms/w8.pdf" }, "w9Form": { "type": "string", "description": "W-9 form URL", "example": "https://example.com/tax-forms/w9.pdf" }, "lastUpdatedBy": { "description": "Who last updated the affiliate", "allOf": [ { "type": "object", "properties": { "source": { "type": "string", "description": "Source of the action", "example": "oauth" }, "channel": { "type": "string", "description": "Channel of the action", "example": "oauth" }, "sourceId": { "type": "string", "description": "Source id of the actor", "example": "source_123" }, "sourceName": { "type": "string", "description": "Source name of the actor", "example": "Marketplace App" }, "timestamp": { "type": "string", "description": "Timestamp when the action happened", "example": "2024-06-16T00:00:00.000Z" } }, "title": "AffiliateAuditResponseDto" } ] }, "email": { "type": "string", "description": "Affiliate email", "example": "john.doe@example.com" }, "revenue": { "type": "number", "description": "Affiliate revenue", "example": 1250.5 }, "companyName": { "type": "string", "description": "Company name", "example": "Doe Media LLC" }, "companyPhoneNumber": { "type": "string", "description": "Company phone number", "example": "+1 888 888-8888" }, "country": { "type": "string", "description": "Country the affiliate was created with", "example": "US" }, "commissionTier": { "type": "number", "description": "Commission tier the affiliate sits in", "example": 1 }, "customer": { "type": "number", "description": "Customer count", "example": 15 }, "lead": { "type": "number", "description": "Lead count", "example": 5 }, "droppedCustomer": { "type": "number", "description": "Dropped customer count", "example": 2 }, "clickCount": { "type": "number", "description": "Click count", "example": 100 }, "paid": { "type": "number", "description": "Commission already paid out", "example": 500 }, "currency": { "type": "string", "description": "Currency of revenue, paid and owned", "example": "USD" }, "owned": { "type": "number", "description": "Commission owed but not yet paid — approved and pending commission combined", "example": 750 } }, "required": [ "_id", "locationId", "email" ], "title": "OAuthAffiliateListItemResponseDto" } ] }, "gatewayState": { "type": "string", "description": "What to show for a gateway-settled payout. Resolved by the backend; not a stored field.", "enum": [ "paid", "processing", "failed", "none" ], "example": "processing" }, "gatewayProgress": { "type": "string", "description": "What an in-flight payout is waiting for. Present only while a gateway still holds it.", "enum": [ "submitted", "processing", "waiting_to_be_claimed", "on_hold", "unknown_status" ], "example": "waiting_to_be_claimed" }, "attempt": { "type": "object", "description": "The public slice of an open gateway attempt.", "example": { "batchId": "A1B2C3D4E5F6G", "startedAt": "2026-08-11T09:00:00.000Z" } }, "failureHistory": { "description": "Why a gateway declined this payout, newest last. Present only on a failed payout.", "example": [ { "reasonCode": "batch_denied", "errorMessage": "Declined by risk review", "debugId": "a1b2c3d4e5f6", "transactionStatus": "DENIED", "failedAt": "2026-08-11T09:05:00.000Z" } ], "type": "array", "items": { "type": "array" } } }, "required": [ "_id", "locationId", "affiliateId", "currency", "amount" ], "title": "PayoutListItemResponseDto" } }, "meta": { "description": "Pagination metadata", "allOf": [ { "type": "object", "properties": { "count": { "type": "number", "description": "Total payouts matching the filters", "example": 42 } }, "required": [ "count" ], "title": "PayoutListMetaResponseDto" } ] } }, "required": [ "payouts" ], "title": "GetPayoutListResponseDto" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/affiliate-manager/payouts?locationId=' \ -H 'Authorization: Bearer ' \ -H 'Version: v4' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: 'v4' } }; try { const response = await fetch('https://services.leadconnectorhq.com/affiliate-manager/payouts?locationId=', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/affiliate-manager/payouts" headers = { "Authorization": "Bearer ", "Version": "v4" } params = { "locationId": "" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/affiliate-manager/payouts?locationId=', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v4', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/affiliate-manager/payouts?locationId=") .header("Authorization", "Bearer ") .header("Version", "v4") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/affiliate-manager/payouts?locationId=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v4") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/affiliate-manager/payouts?locationId=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "v4" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v4" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/affiliate-manager/payouts?locationId=' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```