SolutionsPricingDocsStart Free
PlatformAutomationsAPI

List Partner Payouts

GET
/v1/partners/{participantId}/payouts

List the payouts of one partner from this Project, newest first, and its Rewards that wait for a payout. Read only: payouts are run in the Console. Needs the partners:read key permission.

Authorization

WorkspaceApiKey
X-Api-Key<token>

Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser.

In: header

Path Parameters

participantId*string
Match\S
Length1 <= length <= 512

Query Parameters

projectId*string
Length1 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/partners/string/payouts?projectId=string"
{  "success": true,  "data": {    "terms": {      "version": "string",      "acceptedAt": "string"    },    "taxForm": {      "formType": "w9",      "state": "on_file",      "signedAt": "string",      "expiresAt": "string"    },    "disbursements": [      {        "id": "string",        "environment": "sandbox",        "method": "paypal",        "currency": "string",        "status": "pending",        "amountMinor": "string",        "rewardCount": 1,        "programIds": [          "string"        ],        "createdAt": "string",        "paidAt": "string"      }    ],    "waiting": [      {        "environment": "sandbox",        "reason": "awaiting_operator",        "currency": "string",        "count": 1,        "amountMinor": "string"      }    ]  }}

List Partner Applications GET

List the partner applications of a Project, 50 at a time, newest first, with their answers; filter by status. Needs the partners:read key permission.

List Partners GET

List the partners of a Project, 50 at a time, with their invitations, applications, and metrics. Needs the partners:read key permission.