Skip to main content
GET
List destinations

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Path Parameters

accountId
string<uuid>
required

Account ID or subaccount ID (a UUID).

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

Query Parameters

after
string

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

Minimum string length: 1
limit
integer<int64>
default:100

Maximum number of results to return per query

Required range: 1 <= x <= 1000
ownerType
enum<string>

The type of owner to filter by. Use together with ownerId. The kind of entity that owns a destination, indicating how the owner's id should be interpreted.

  • ORGANIZATION - the organization, at the top of the account tree.
  • ACCOUNT - an account. An Omni account holds destinations directly; an FBO account holds them for its subaccounts.
  • SUBACCOUNT - a single subaccount.
  • CUSTOMER - a program customer.
Available options:
ORGANIZATION,
ACCOUNT,
SUBACCOUNT,
CUSTOMER
Example:

"ACCOUNT"

ownerId
string

The ID of the owner to filter by, interpreted according to ownerType.

type
enum<string>

Filter by destination type. Indicates which variant object carries the destination's details.

Available options:
CRYPTO,
FIAT
Example:

"CRYPTO"

status
enum<string>

Filter by lifecycle status. The destination's position in its lifecycle.

  • PENDING - creation is in progress. This status does not report which step is outstanding: the steps are internal, some of them wait on action the API caller cannot take, and the mechanism that approves a destination is expected to change.
  • ACTIVE - the destination exists and can be withdrawn to.
  • DELETING - removal is in progress.
  • REJECTED - creation was declined. See statusReason.
  • FAILED - creation could not be completed. See statusReason.
  • CANCELED - creation was canceled before it completed.
  • DELETED - the destination was removed.
Available options:
PENDING,
ACTIVE,
DELETING,
REJECTED,
FAILED,
CANCELED,
DELETED
Example:

"ACTIVE"

address
string

Filter by crypto address.

networkId
string

A unique string identifying a combination of blockchain and environment (testnet, mainnet).

assetType
string

Asset type identifier. Returns destinations with a matching assetType, as well as network-level destinations on the matching network.

name
string

Filter by destination name.

externalId
string

Look up the destination created by a given request. The externalId supplied at creation remains a valid key for the destination it created.

Response

List of destinations

data
Destination · object[]
required
page
Page · object
required

Pagination info