---
title: "List Orchestrations"
method: GET
path: "/orchestration/orchestrations"
tags: ["Orchestrations"]
---

# List Orchestrations

`GET /orchestration/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

## Query parameters

- `orchestration_rule_id` string[]
- `source_asset` string[]
- `destination_asset` string[]
- `status` string[]
- `created_at.lt` string, date-time
- `created_at.lte` string, date-time
- `created_at.eq` string, date-time
- `created_at.gte` string, date-time
- `created_at.gt` string, date-time
- `limit` integer
- `order` 'DESC' | 'ASC'
- `page_cursor` string
- `orchestration_id` string[]
- `profile_id` string[]
- `ref_id` string[]

## Response `200`

A successful response.

- ListOrchestrationsResponse
  - `orchestrations` Orchestration[] — Deprecated: Use items instead. This field will be removed in a future version.
    - `id` string
    - `profile_id` string
    - `identity_id` string
    - `account_id` string
    - `customer_id` string
    - `ref_id` string — A client or system-specified unique identifier for the orchestration - used for idempotency protection. Retries of a request should use the same ref_id to avoid duplicate transactions. For system-initiated orchestrations generated by invocation of an orchestration rule, the ref_id is generated the system.
    - `source_asset` string
    - `destination_asset` string
    - `source_amount` string, decimal
    - `source_transfer` TransferDetails — TransferDetails refers to a specific Transfer and encodes its current status.
      - `transfer_id` string
      - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' — - PENDING: PENDING: a transfer is planned, but its resource_id is not yet known. - PROCESSING: PROCESSING: a transfer with `resource_id` is being processed. resource_id is guaranteed to be set if the status is PROCESSING. - COMPLETED: COMPLETED: a transfer with `resource_id` has successfully completed. - FAILED: FAILED: a transfer with `resource_id` has failed.
    - `destination_transfer` TransferDetails — TransferDetails refers to a specific Transfer and encodes its current status.
      - `transfer_id` string
      - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' — - PENDING: PENDING: a transfer is planned, but its resource_id is not yet known. - PROCESSING: PROCESSING: a transfer with `resource_id` is being processed. resource_id is guaranteed to be set if the status is PROCESSING. - COMPLETED: COMPLETED: a transfer with `resource_id` has successfully completed. - FAILED: FAILED: a transfer with `resource_id` has failed.
    - `status` 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'REJECTED' — Status represents the current state of an orchestration. - PROCESSING: The orchestration is actively being processed. - COMPLETED: The orchestration completed successfully. - FAILED: The orchestration failed during processing. - PENDING: The orchestration is awaiting approval before processing begins. Once approved, it transitions to PROCESSING. If rejected, it transitions to REJECTED. - REJECTED: The orchestration was rejected during approval.
    - `fail_reason` FailReason
      - `detail` string
    - `source` OrchestrationSource
      - `crypto` OrchestrationCryptoSource
        - `address_id` string
        - `address` string
        - `network` string
      - `fiat` OrchestrationFiatSource
        - `deposit_instructions_id` string
        - `memo` string
      - `profile` OrchestrationProfileSource
        - `profile_id` string
    - `destination` OrchestrationDestination
      - `crypto` OrchestrationCryptoDestination
        - `address_id` string
        - `address` string
        - `network` string
      - `fiat` OrchestrationFiatDestination
        - `bank_account_id` string
        - `memo` string
      - `profile` OrchestrationProfileDestination
        - `profile_id` string
    - `orchestration_rule_id` string — The ID of the orchestration rule which triggered this orchestration. Can be empty for ad-hoc orchestrations.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `metadata` object
  - `next_page_cursor` string
  - `items` Orchestration[]
    - `id` string
    - `profile_id` string
    - `identity_id` string
    - `account_id` string
    - `customer_id` string
    - `ref_id` string — A client or system-specified unique identifier for the orchestration - used for idempotency protection. Retries of a request should use the same ref_id to avoid duplicate transactions. For system-initiated orchestrations generated by invocation of an orchestration rule, the ref_id is generated the system.
    - `source_asset` string
    - `destination_asset` string
    - `source_amount` string, decimal
    - `source_transfer` TransferDetails — TransferDetails refers to a specific Transfer and encodes its current status.
      - `transfer_id` string
      - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' — - PENDING: PENDING: a transfer is planned, but its resource_id is not yet known. - PROCESSING: PROCESSING: a transfer with `resource_id` is being processed. resource_id is guaranteed to be set if the status is PROCESSING. - COMPLETED: COMPLETED: a transfer with `resource_id` has successfully completed. - FAILED: FAILED: a transfer with `resource_id` has failed.
    - `destination_transfer` TransferDetails — TransferDetails refers to a specific Transfer and encodes its current status.
      - `transfer_id` string
      - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' — - PENDING: PENDING: a transfer is planned, but its resource_id is not yet known. - PROCESSING: PROCESSING: a transfer with `resource_id` is being processed. resource_id is guaranteed to be set if the status is PROCESSING. - COMPLETED: COMPLETED: a transfer with `resource_id` has successfully completed. - FAILED: FAILED: a transfer with `resource_id` has failed.
    - `status` 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'REJECTED' — Status represents the current state of an orchestration. - PROCESSING: The orchestration is actively being processed. - COMPLETED: The orchestration completed successfully. - FAILED: The orchestration failed during processing. - PENDING: The orchestration is awaiting approval before processing begins. Once approved, it transitions to PROCESSING. If rejected, it transitions to REJECTED. - REJECTED: The orchestration was rejected during approval.
    - `fail_reason` FailReason
      - `detail` string
    - `source` OrchestrationSource
      - `crypto` OrchestrationCryptoSource
        - `address_id` string
        - `address` string
        - `network` string
      - `fiat` OrchestrationFiatSource
        - `deposit_instructions_id` string
        - `memo` string
      - `profile` OrchestrationProfileSource
        - `profile_id` string
    - `destination` OrchestrationDestination
      - `crypto` OrchestrationCryptoDestination
        - `address_id` string
        - `address` string
        - `network` string
      - `fiat` OrchestrationFiatDestination
        - `bank_account_id` string
        - `memo` string
      - `profile` OrchestrationProfileDestination
        - `profile_id` string
    - `orchestration_rule_id` string — The ID of the orchestration rule which triggered this orchestration. Can be empty for ad-hoc orchestrations.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `metadata` object

---

[API](https://skmtc.net/paxos/apis/paxos-api.md) · [All operations](https://skmtc.net/paxos/apis/paxos-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paxos/paxos-api/revisions/0687ca8c9a8d/schema)