Skip to main content
GET
/
orchestration
/
orchestrations
List Orchestrations
curl --request GET \
  --url https://api.paxos.com/v2/orchestration/orchestrations \
  --header 'Authorization: Bearer <token>'
{
  "orchestrations": [
    {
      "id": "<string>",
      "profile_id": "<string>",
      "identity_id": "<string>",
      "account_id": "<string>",
      "customer_id": "<string>",
      "ref_id": "<string>",
      "source_asset": "<string>",
      "destination_asset": "<string>",
      "source_amount": "<string>",
      "source_transfer": {
        "transfer_id": "<string>",
        "status": "PENDING"
      },
      "destination_transfer": {
        "transfer_id": "<string>",
        "status": "PENDING"
      },
      "status": "PROCESSING",
      "fail_reason": {
        "detail": "<string>"
      },
      "source": {
        "crypto": {
          "address_id": "<string>",
          "address": "<string>",
          "network": "<string>"
        },
        "fiat": {
          "deposit_instructions_id": "<string>",
          "memo": "<string>"
        },
        "profile": {
          "profile_id": "<string>"
        }
      },
      "destination": {
        "crypto": {
          "address": "<string>",
          "network": "<string>",
          "address_id": "<string>"
        },
        "fiat": {
          "bank_account_id": "<string>",
          "memo": "<string>"
        },
        "profile": {
          "profile_id": "<string>"
        }
      },
      "orchestration_rule_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "next_page_cursor": "<string>"
}
OAuth Scope
orchestration:read_orchestration

Authorizations

​
Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide →

Query Parameters

​
orchestration_rule_id
string[]

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_asset
string[]

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

​
destination_asset
string[]

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

​
status
string[]

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

​
created_at.lt
string<date-time>

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

​
created_at.lte
string<date-time>

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

​
created_at.eq
string<date-time>

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

​
created_at.gte
string<date-time>

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

​
created_at.gt
string<date-time>

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

​
limit
integer

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

​
order
enum<string>

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

Available options:
DESC,
ASC
​
page_cursor
string

Optional Cursor for getting the next page of results.

​
orchestration_id
string[]

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_id
string[]

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

Response

200 - application/json

A successful response.

​
orchestrations
object[]
​
next_page_cursor
string
⌘I