List payout runs

List the payout runs the authenticated agent created, newest first.

GET /agents/me/payout-runs

List payout runs

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/payout-runs \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "PayoutRun:019542f5-b3e7-1d02-0000-000000000001",
      "status": "VALIDATING",
      "source": {
        "accountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
        "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001"
      },
      "allOrNothing": false,
      "rowCounts": {
        "total": 1000,
        "pending": 0,
        "pendingClaim": 12,
        "processing": 0,
        "completed": 980,
        "failed": 8,
        "skipped": 0
      },
      "createdAt": "2026-11-04T22:00:00Z",
      "updatedAt": "2026-11-05T02:14:00Z",
      "agentId": "Agent:019542f5-b3e7-1d02-0000-000000000042",
      "agentActionId": "AgentAction:019542f5-b3e7-1d02-0000-000000000099",
      "total": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "rowCount": 12,
      "scheduledAt": "2026-11-05T02:00:00Z",
      "finishedAt": "2026-11-05T02:14:00Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.

Query Parameters

status · enum<string>

Only runs in this status Status of a payout run.

Status	Description
VALIDATING	Grid is validating the rows. No row is paid yet.
PENDING_APPROVAL	An agent's run waiting for the customer to approve its PAYOUT_RUN action. No row is paid yet. Approving it makes the run PROCESSING; rejecting it, or letting it expire, makes it CANCELLED.
SCHEDULED	Accepted, waiting for scheduledAt.
PROCESSING	Rows are being paid.
COMPLETED	Every accepted row completed or is held for a claim, and none failed.
PARTIALLY_FAILED	At least one row completed or is held for a claim, and at least one failed.
FAILED	No row completed or is held for a claim.
CANCELLED	Cancelled. Rows that had not started are SKIPPED.

Available options: VALIDATING, PENDING_APPROVAL, SCHEDULED, PROCESSING, COMPLETED, PARTIALLY_FAILED, FAILED, CANCELLED

limit · integer · default: 50

Maximum number of results to return (default 50, max 200)

Required range: 1 <= x <= 200

cursor · string

Cursor for pagination (returned from previous request)

Response

200

application/json

Successful operation

data · object[] · required

Show child attributes

hasMore · boolean · required

Indicates if more results are available beyond this page.

nextCursor · string

Cursor to retrieve the next page of results (only present if hasMore is true).