Skip to main content
GET
List destinations

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Query Parameters

cursor
string

Pass the opaque value returned in metadata.nextCursor without changing the other query parameters.

contactId
string

Return destinations owned by one contact.

type
enum<string>

Return one destination type.

Available options:
bank_account,
international_wire

Search by destination name or id.

includeArchived
boolean
default:false

Include archived destinations. Defaults to false.

Response

A page of destinations.

items
(DestinationBankAccount · object | DestinationInternationalWire · object)[]
required

US routing and account details usable for ACH, wire, or realtime payments.

metadata
PaginationMetadata · object
required