List Destinations
List destinations on the specified project. To learn more about destinations, read Destinations.
Listing, Sorting and Filtering Destinations
This endpoint returns the list of destinations in the specified project.
Sorting
The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas
where each one can optionally specify asc or desc.
Sorting is valid on the following fields: created, createdBy, displayName, id, labels, name, status/state, updated, updatedBy
Filtering
There are two ways to filter the set of returned destinations from this endpoint - the first is to use the $filter query parameter, the second is to use the
$label_key and $label query parameters.
The $filter query parameter allows for destinations to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, displayName, id, labels, name, status/state, updated, updatedBy, updatedByEmail, updatedByName
$label_key and $label are specific to querying destinations based on their labels. Labels are a set of key-value pairs that can be used to identify destinations with
any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of destinations.
Examples:
?$top=10 - Returns only the first 10 destinations from the list.
?$orderby=name desc - Sorts destinations by name in descending order.
?$filter=name eq 'descriptive name' - Returns destinations that match the provided name.
?$orderby=created desc - Sorts destinations by creation date in descending order.
?$filter=created ge 2021-01-01T00:00:00Z - Returns destinations created after January 1, 2021.
?$label=studio=paravalley - Returns destinations with the label studio set to paravalley.
?$label=release-date~2023 - Returns destinations with the label release-date set to a value that contains 2023.
?$label_key=studio&label_key=release-date - Returns destinations with any value set for the studio label and the release-date label.
RBAC Capability Required: flow.destination.get
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Query parameters
Specifies a non-negative integer n that limits the number of items returned from a collection.
The service returns the number of available items up to but not greater than the specified value n.
Specifies a start offset to support paginated results.
Use @odata.nextLink in the result object to enumerate the collection -
it will be present only if there's more than one page of entities.
Filters the set to the specified label key. If multiple $label_keys are specified, matching items must have all labels.
Filters the set to the specified label key/value pair. Supports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.
Response
@odata.nextLink URL if the page length and number of items match.