For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/gateway/list-allocations.md.

List allocations

Organization tokenNo token

GET
/custody/allocations

Returns a paginated list of the caller's allocations, newest first.

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

An access token from POST /v1/auth/api-key/token. An organization token lasts one hour and has no refresh token; a personal token can be refreshed.

Query Parameters

status?string

Filter by allocation status

Value in"allocating""crediting""releasing""completed""rejected""stranded"
cursor?string

Opaque pagination cursor from the previous page's next_cursor

limit?integer

Maximum number of allocations to return

Range1 <= value <= 100
Default50

Header Parameters

TM-On-Behalf-Of?string

Act as one of your organization's users. The value is the user_id returned when the user was created; the request then reads and writes that user's account. Requires an organization token and a user your organization created: 400 for a personal token, a repeated header or a non-UUID, 403 for a user outside your organization. Not accepted on organization-scoped routes.

Formatuuid

Response Body

Allocations retrieved successfully

application/json
  1. response

Paginated list of allocations

data?array<>

List of allocations

pagination?

Cursor-based pagination metadata. The cursor is opaque and must be passed back verbatim; never parse or construct one.

Example Request
curl -X GET 'https://api.truemarkets.co/v1/gateway/custody/allocations' \  -H 'TM-On-Behalf-Of: 3f6d2c0e-8a41-4c2b-9f1e-2b7d5c0a9e11'
Example Response
{  "data": [    {      "id": "c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",      "status": "crediting",      "asset_id": "b3d9e5f2-1a4c-4e7b-9f0d-2c8a6b3e5f91",      "asset_symbol": "USDC",      "amount": "100.00",      "allocated_total": "250.00",      "transfer": {        "id": "a7f3c2e1-9b4d-4e6f-8a1c-3d5e7f9b2c4a",        "status": "COMPLETED"      },      "failure_reason": "cefi REJECTED",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "next_cursor": "string",    "limit": 0  }}