--- title: "Retrieve destinations" method: GET path: "/destinations" tags: ["Destinations"] --- # Retrieve destinations `GET /destinations` This endpoint lists destinations, or a subset of destinations. ## Query parameters - `id` union — Filter by destination IDs - string - string[] - `name` union — The destination name - string - Operators - `gt` string, date-time, nullable - `gte` string, date-time, nullable - `le` string, date-time, nullable - `lte` string, date-time, nullable - `any` boolean - `all` boolean - string[] - `type` union — Filter by destination type - 'HTTP' | 'CLI' | 'MOCK_API' - string[] - `disabled` boolean — Include disabled resources in the response - `disabled_at` union — Date the destination was disabled - string, date-time, nullable - Operators - `gt` string, date-time, nullable - `gte` string, date-time, nullable - `le` string, date-time, nullable - `lte` string, date-time, nullable - `any` boolean - `all` boolean - `order_by` 'name' | 'created_at' | 'updated_at' — Sort key - `dir` 'asc' | 'desc' — Sort direction - `limit` integer — Result set size - `next` string — The ID to provide in the query to get the next set of results - `prev` string — The ID to provide in the query to get the previous set of results ## Response `200` List of destinations - DestinationPaginatedResult - `pagination` SeekPagination - `order_by` union - string - string[] - `dir` union - union - 'asc' - 'desc' - 'ASC' - 'DESC' - OrderByDirection[] - union - 'asc' - 'desc' - 'ASC' - 'DESC' - `limit` integer - `prev` string - `next` string - `count` integer - `models` Destination[] - `id` string, required — ID of the destination - `name` string, required — A unique, human-friendly name for the destination - `description` string, nullable — Description of the destination - `team_id` string, required — ID of the project - `type` 'HTTP' | 'CLI' | 'MOCK_API', required — Type of the destination - `config` union — Configuration object for the destination type - object — The type config for HTTP. Requires type to be `HTTP`. - `url` string, URL, required - `rate_limit` number, float, nullable - `rate_limit_period` 'second' | 'minute' | 'hour' | 'concurrent', nullable - `delivery_groups` DestinationDeliveryGroups, nullable — Delivery groups configuration for this destination - `key` string, required — Payload field path used to compute the delivery group, e.g. `body.customer_id`. Scalar values group as-is (non-scalar values are JSON-serialized); events where the path does not resolve group under `__unknown__`. - `rate_limit` integer, nullable — Default delivery rate limit per group. - `rate_limit_period` 'second' | 'minute' | 'hour', nullable — Default delivery rate limit period per group - `overrides` object, nullable — Delivery rate limit overrides keyed by computed delivery group - `path_forwarding_disabled` boolean - `http_method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', nullable - `auth_type` 'HOOKDECK_SIGNATURE' | 'CUSTOM_SIGNATURE' | 'BASIC_AUTH' | 'API_KEY' | 'BEARER_TOKEN' | 'OAUTH2_CLIENT_CREDENTIALS' | 'OAUTH2_AUTHORIZATION_CODE' | 'AWS_SIGNATURE' | 'GCP_SERVICE_ACCOUNT', nullable - `auth` union - object - object - `key` string - `signing_secret` string - object - `username` string - `password` string - object - `key` string - `api_key` string - `to` 'header' | 'query' - object - `token` string - object - `auth_server` string - `client_id` string - `client_secret` string - `scope` string - `authentication_type` 'basic' | 'bearer' | 'x-www-form-urlencoded' - object - `auth_server` string - `client_id` string - `client_secret` string - `refresh_token` string - `scope` string - object - `access_key_id` string - `secret_access_key` string - `region` string - `service` string - object - `service_account_key` string - `scope` string, nullable - object, nullable - object — The type config for CLI. Requires type to be `CLI`. - `path` string, required — Path for the CLI destination - `path_forwarding_disabled` boolean - `http_method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', nullable - `auth_type` 'HOOKDECK_SIGNATURE' | 'CUSTOM_SIGNATURE' | 'BASIC_AUTH' | 'API_KEY' | 'BEARER_TOKEN' | 'OAUTH2_CLIENT_CREDENTIALS' | 'OAUTH2_AUTHORIZATION_CODE' | 'AWS_SIGNATURE' | 'GCP_SERVICE_ACCOUNT', nullable - `auth` union - object - object - `key` string - `signing_secret` string - object - `username` string - `password` string - object - `key` string - `api_key` string - `to` 'header' | 'query' - object - `token` string - object - `auth_server` string - `client_id` string - `client_secret` string - `scope` string - `authentication_type` 'basic' | 'bearer' | 'x-www-form-urlencoded' - object - `auth_server` string - `client_id` string - `client_secret` string - `refresh_token` string - `scope` string - object - `access_key_id` string - `secret_access_key` string - `region` string - `service` string - object - `service_account_key` string - `scope` string, nullable - object, nullable - object — The type config for MOCK_API. Requires type to be `MOCK_API`. - `rate_limit` number, float, nullable - `rate_limit_period` 'second' | 'minute' | 'hour' | 'concurrent', nullable - `delivery_groups` DestinationDeliveryGroups, nullable — Delivery groups configuration for this destination - `key` string, required — Payload field path used to compute the delivery group, e.g. `body.customer_id`. Scalar values group as-is (non-scalar values are JSON-serialized); events where the path does not resolve group under `__unknown__`. - `rate_limit` integer, nullable — Default delivery rate limit per group. - `rate_limit_period` 'second' | 'minute' | 'hour', nullable — Default delivery rate limit period per group - `overrides` object, nullable — Delivery rate limit overrides keyed by computed delivery group - `path_forwarding_disabled` boolean - `http_method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', nullable - `auth_type` 'HOOKDECK_SIGNATURE' | 'CUSTOM_SIGNATURE' | 'BASIC_AUTH' | 'API_KEY' | 'BEARER_TOKEN' | 'OAUTH2_CLIENT_CREDENTIALS' | 'OAUTH2_AUTHORIZATION_CODE' | 'AWS_SIGNATURE' | 'GCP_SERVICE_ACCOUNT', nullable - `auth` union - object - object - `key` string - `signing_secret` string - object - `username` string - `password` string - object - `key` string - `api_key` string - `to` 'header' | 'query' - object - `token` string - object - `auth_server` string - `client_id` string - `client_secret` string - `scope` string - `authentication_type` 'basic' | 'bearer' | 'x-www-form-urlencoded' - object - `auth_server` string - `client_id` string - `client_secret` string - `refresh_token` string - `scope` string - object - `access_key_id` string - `secret_access_key` string - `region` string - `service` string - object - `service_account_key` string - `scope` string, nullable - object, nullable - `disabled_at` string, date-time, nullable, required — Date the destination was disabled - `updated_at` string, date-time, required — Date the destination was last updated - `created_at` string, date-time, required — Date the destination was created ## Other responses - `400` — Bad Request - `422` — Unprocessable Entity --- [API](https://skmtc.net/hookdeck/apis/hookdeck-admin-rest-api.md) · [All operations](https://skmtc.net/hookdeck/apis/hookdeck-admin-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hookdeck/hookdeck-admin-rest-api/versions/31da4ed27d31/schema)