---
title: "List Orchestration Rules"
method: GET
path: "/orchestration/rules"
tags: ["Orchestration Rules"]
---

# List Orchestration Rules

`GET /orchestration/rules`

List all orchestration rules, optionally filtering and paging the results.

By default, orchestration rules 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 rules which were created.

The paginated results default to display up to 100 rules, 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.

Rules can be filtered by:
- Profile ID (`profile_id`)
- Status (`status`)
- Source asset (`source_asset`)
- Destination asset (`destination_asset`)

## Query parameters

- `profile_id` string
- `status` string[]
- `source_asset` string
- `destination_asset` string
- `ids` string[]
- `limit` integer
- `order` 'DESC' | 'ASC'
- `page_cursor` string

## Response `200`

A successful response.

- ListOrchestrationRulesResponse
  - `rules` OrchestrationRule[] — Deprecated: Use items instead. This field will be removed in a future version.
    - `id` string — Unique identifier for the orchestration rule.
    - `ref_id` string — Unique reference ID for the rule.
    - `nickname` string — Optional human-readable nickname for the rule.
    - `profile_id` string — Profile ID of the account owner.
    - `identity_id` string — Identity ID of the account owner.
    - `account_id` string — Account ID where the rule applies.
    - `status` 'ACTIVE' | 'DELETED' | 'PENDING' | 'REJECTED' — - ACTIVE: The rule is active, deposits matching the `source_asset` and `source` of this rule start a conversion and subsequent delivery of the `destination_asset` to the specified `destination`. - DELETED: The rule has been deleted, newly deposited `source_assets` to the `source` of this rule will not be converted. The deposited `source_asset` is still going to be credited to the Profile specified by `profile_id`. - PENDING: The rule creation is pending approval(s) before the rule becomes ACTIVE. - REJECTED: The rule creation has been rejected during the approval process.
    - `source_asset` string — Asset being converted from.
    - `destination_asset` string — Asset being converted to.
    - `source` OrchestrationRuleSource
      - `crypto` OrchestrationRuleCryptoSource
        - `address_id` string
        - `address` string
        - `network` string
      - `fiat` OrchestrationRuleFiatSource
        - `deposit_instructions_id` string
        - `network` string
        - `account_type` string
        - `memo_id` string
      - `profile` OrchestrationRuleProfileSource
        - `profile_id` string
    - `destination` OrchestrationRuleDestination
      - `crypto` OrchestrationRuleCryptoDestination
        - `address` string
        - `network` string
      - `fiat` OrchestrationRuleFiatDestination
        - `fiat_account_id` string
        - `memo` string
      - `profile` OrchestrationRuleProfileDestination
        - `profile_id` string
    - `created_at` string, date-time — Timestamp when the rule was created.
  - `next_page_cursor` string
  - `items` OrchestrationRule[]
    - `id` string — Unique identifier for the orchestration rule.
    - `ref_id` string — Unique reference ID for the rule.
    - `nickname` string — Optional human-readable nickname for the rule.
    - `profile_id` string — Profile ID of the account owner.
    - `identity_id` string — Identity ID of the account owner.
    - `account_id` string — Account ID where the rule applies.
    - `status` 'ACTIVE' | 'DELETED' | 'PENDING' | 'REJECTED' — - ACTIVE: The rule is active, deposits matching the `source_asset` and `source` of this rule start a conversion and subsequent delivery of the `destination_asset` to the specified `destination`. - DELETED: The rule has been deleted, newly deposited `source_assets` to the `source` of this rule will not be converted. The deposited `source_asset` is still going to be credited to the Profile specified by `profile_id`. - PENDING: The rule creation is pending approval(s) before the rule becomes ACTIVE. - REJECTED: The rule creation has been rejected during the approval process.
    - `source_asset` string — Asset being converted from.
    - `destination_asset` string — Asset being converted to.
    - `source` OrchestrationRuleSource
      - `crypto` OrchestrationRuleCryptoSource
        - `address_id` string
        - `address` string
        - `network` string
      - `fiat` OrchestrationRuleFiatSource
        - `deposit_instructions_id` string
        - `network` string
        - `account_type` string
        - `memo_id` string
      - `profile` OrchestrationRuleProfileSource
        - `profile_id` string
    - `destination` OrchestrationRuleDestination
      - `crypto` OrchestrationRuleCryptoDestination
        - `address` string
        - `network` string
      - `fiat` OrchestrationRuleFiatDestination
        - `fiat_account_id` string
        - `memo` string
      - `profile` OrchestrationRuleProfileDestination
        - `profile_id` string
    - `created_at` string, date-time — Timestamp when the rule was created.

---

[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/versions/0687ca8c9a8d/schema)