v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB

Orchestrations

List Orchestrations

List all orchestrations, optionally filtering and paging the results.

By default, orchestrations are returned in reverse chronological (descending) order by creation time. If no query parameters are supplied, the response will include up to the last 100 orchestrations which were created.

The paginated results default to display up to 100 orchestrations, unless otherwise specified with the limit parameter. The maximum limit value is 1000. Every paginated response contains a next_page_cursor field until the last page is reached.

Pass the next_page_cursor value into the page_cursor field of a new request to retrieve the next page of results.

When filtering by profile IDs using the profile_ids parameter, there is a limit of 100 profiles that can be specified in a single request.

Orchestrations are provided for various operations including:

Deposits to a paxos-platform crypto address or bank account
Withdrawals to a customer-owned crypto address or bank account
Conversions from one asset to another
Orchestrated workflows involving some or all of the above
Invocation of an Orchestration Rule

get/orchestration/orchestrations

Query parameters

orchestration_rule_idstring[]

Optionally filter by the initiating orchestration rule ids. There is a limit of 100 orchestration rule ids that can be specified in a single request.

source_assetstring[]

Optionally filter by source assets. There is a limit of 100 source assets that can be specified in a single request.

destination_assetstring[]

Optionally filter by destination assets. There is a limit of 100 destination assets ids that can be specified in a single request.

statusstring[]

Optionally filter by statuses. There is a limit of 100 statuses that can be specified in a single request.

created_at.ltstring date-time

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.ltestring date-time

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.eqstring date-time

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gtestring date-time

Include timestamps greater than or equal to gte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gtstring date-time

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

limitinteger

Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.

order'DESC' | 'ASC'

Sort order for the results. Defaults to DESC by created_at time.

page_cursorstring

Optional Cursor for getting the next page of results.

orchestration_idstring[]

Optionally filter by a list of orchestration IDs. There is a limit of 100 orchestration ids that can be specified in a single request.

profile_idstring[]

Optionally filter by the target profiles. There is a limit of 100 profiles that can be specified in a single request.

ref_idstring[]

Optionally filter by client-provided reference IDs. There is a limit of 100 ref_ids that can be specified in a single request.

Response

A successful response.

next_page_cursorstring

Example response

{
  "orchestrations": [
    {
      "id": "e5f6a7b8-9c0d-1e2f-3a4b-c5d6e7f8a9b0",
      "profile_id": "7c4e8f2a-1d3b-4a5e-9f6c-8b2d7e0a4f1c",
      "customer_id": "a1b2c3d4-5e6f-7a8b-9c0d-e1f2a3b4c5d6",
      "ref_id": "orch-usdc-usdg-a3b1c2d4",
      "source_asset": "USDC",
      "destination_asset": "USDG",
      "source_amount": "100",
      "status": "PROCESSING",
      "source": {
        "profile": {
          "profile_id": "7c4e8f2a-1d3b-4a5e-9f6c-8b2d7e0a4f1c"
        }
      },
      "destination": {
        "crypto": {
          "address_id": "d4e5f6a7-8b9c-0d1e-2f3a-b4c5d6e7f8a9"
        }
      },
      "created_at": "2026-04-20T12:30:01.397730Z",
      "updated_at": "2026-04-20T12:30:01.397730Z",
      "metadata": {
        "my_id": "4f8a2b6c-9d1e-4c3a-b5f7-0e2d8a7c1b9f"
      }
    }
  ],
  "items": [
    {
      "id": "e5f6a7b8-9c0d-1e2f-3a4b-c5d6e7f8a9b0",
      "profile_id": "7c4e8f2a-1d3b-4a5e-9f6c-8b2d7e0a4f1c",
      "customer_id": "a1b2c3d4-5e6f-7a8b-9c0d-e1f2a3b4c5d6",
      "ref_id": "orch-usdc-usdg-a3b1c2d4",
      "source_asset": "USDC",
      "destination_asset": "USDG",
      "source_amount": "100",
      "status": "PROCESSING",
      "source": {
        "profile": {
          "profile_id": "7c4e8f2a-1d3b-4a5e-9f6c-8b2d7e0a4f1c"
        }
      },
      "destination": {
        "crypto": {
          "address_id": "d4e5f6a7-8b9c-0d1e-2f3a-b4c5d6e7f8a9"
        }
      },
      "created_at": "2026-04-20T12:30:01.397730Z",
      "updated_at": "2026-04-20T12:30:01.397730Z",
      "metadata": {
        "my_id": "4f8a2b6c-9d1e-4c3a-b5f7-0e2d8a7c1b9f"
      }
    }
  ]
}