GET
/v1/admin/payout-tagsEvery tag the firm made for payout requests, by name, with how many requests carry it. The team's own labels: why a request waits, who is on it. Traders never see them, and they never change a status. A firm has a handful, so the list comes whole, without pages.
Filter the list on one with tag.
Needs a firm. Our own staff name one with the Propper-Workspace header.
Request
curl "https://api.proppertrading.com/v1/admin/payout-tags" \
-H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
-H "Propper-Workspace: acme"
Response
{
"data": [
{ "object": "payout_tag", "id": "ptag_yk5b6gy5wq9cp4k3", "name": "Second look", "color": "violet", "count": 2 },
{ "object": "payout_tag", "id": "ptag_mmsktt6kdyg5965a", "name": "VIP", "color": "emerald", "count": 1 },
{ "object": "payout_tag", "id": "ptag_tgy5zudxy8gg8ej6", "name": "Waiting on KYC", "color": "amber", "count": 1 }
],
"meta": {
"request_id": "req_01m50q0e91dynhftqm2ayhc9m9",
"has_more": false,
"next_cursor": null
}
}
| Field | Description |
|---|---|
name | Unique within the firm, up to 50 characters |
color | gray, red, orange, amber, emerald, cyan, blue, violet or pink |
count | How many requests carry it |
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | workspace_required | Asked by our own staff without naming a firm |
| 401 | invalid_token | Not a token, or the secret does not match |
| 401 | revoked_token | Signed out here or from another device |
| 401 | expired_token | Ninety days without use, or a set expiry passed |
| 403 | admin_access_required | This account no longer helps run the environment |
| 403 | insufficient_scope | This device does not hold admin:read |
| 403 | workspace_not_permitted | The Propper-Workspace header names an environment this account cannot act in |
| 403 | forbidden | Without view_payouts |