Get Destinations

Get all available destinations based on the provided filters

  • destination_id (List[UUID]): Optional filter by destination IDs.
  • integration_id (List[UUID]): Optional filter by related integration IDs.
  • name (List[str]): Optional filter by destination names.
  • created_by (List[str]): Optional filter by creation user IDs.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns a paged list of destinations. Each filter takes a list: id, integration_id, name, and created_by.

When to use it

Use it to find a destination's ID for a policy, or to list every destination on one integration.

Required parameters

This call takes no required parameters.

Optional query parameters: id, integration_id, name, created_by. Use page and size to page through the results.

Response

A successful call returns 200 OK with a page of DestinationResponse objects in items, plus the paging fields total, page, size, and pages.

Related: Get a destination, Create a destination, List integrations

Query Params
array | null
array | null
array | null
array | null
integer
≥ 1
Defaults to 1

Page number

integer
1 to 100
Defaults to 50

Page size

Responses

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json