Skip to main content
GET
/
users
/
{id}
/
payouts
Paginated payouts for one employee
curl --request GET \
  --url https://{host}/api/v1/users/{id}/payouts \
  --header 'API-key: <api-key>' \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "next": "<string>",
  "previous": "<string>",
  "count": 123,
  "results": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

Sanctum personal access token (access_tokens / partner API settings).

API-key
string
header
required

UUID API key stored for the partner user.

Path Parameters

id
integer
required

Query Parameters

status
string

Filter by payout status (exact match).

Response

Paginated payouts

total
integer
required
next
string | null
required
previous
string | null
required
count
integer
required
results
LengthAwarePaginator · object[]
required