Sign in
Destinations

List destinations

The Destination endpoint returns the configured data destinations. Destinations are the databases and data warehouses within the consumer environments.

get/destinations

Query parameters

destination_idstring

Destination ID. Multiple IDs can also be provided as a comma-separated string.

namestring

Destination name. Case-insensitive. Multiple values can be provided as a comma-separated string.

vendorstring

Filter by vendor type (postgres, redshift).

is_enabledstring

Filter by enabled status (true or false).

recipient_idstring

Recipient ID. Multiple values can be provided as a comma-separated string.

id_in_provider_systemstring

Id of the organization to whom this recipient corresponds in the provider's system. In other words, likely some kind of org_id or customer_id in your system. Multiple values can be provided as a comma-separated string.

product_namestring

Product name. Multiple values can be provided as a comma-separated string.

model_namestring

Model name. Multiple values can be provided as a comma-separated string.

page_sizeinteger

Number of items to return per page.

order'asc' | 'desc'

Sort order for items

cursorstring

Used for pagination - represents last page seen. Value is included in response when there is a next page.

Response

OK

status'success' required
dataListDestinationResponse required— unresolved $ref
messagestring required
has_nextboolean required

Whether there are more items beyond this page.

next_urlstring

Full URL to fetch the next page. Only present when has_next is true.

Changes