Skip to main content
Retrieve a Destination’s metadata, source Target Lists, workflow execution state, connection configuration, and Console summary.

Authentication

All requests require a workspace API key:
The examples use $API_KEY for your API key. The key determines the workspace; you do not supply a workspace ID. See Authentication.

Path parameter

Request

Response

200 OK — returns the Destination object directly.
All names, domains, identifiers, amounts, URLs, and timestamps in these examples are illustrative.

Destination fields

Understand Destination state

status: active means the Destination exists. A Destination can be active while its workflow is stopped. workflow_status describes the associated workflow’s execution state. It uses the shared workflow status vocabulary; clients should not infer it from Buyer counts. is_connected: true means connection configuration exists. It is not a live health check and does not guarantee valid credentials, a reachable endpoint, or a successful delivery. Inspect the Console for actual outcomes.

Delivery settings

Console summary

total, pushed, pending, and failed count unique Buyers by their latest delivery state, across the complete Destination Console. They do not count raw attempts or retries. An empty Console returns zero counts. Use Retrieve Destination Console to inspect Buyer records and delivery reasons.

Resource access

Missing, deleted, or inaccessible Destinations return 404 not_found. Provider credentials, field-mapping payloads, workflow graphs, and raw execution logs are not returned.

Errors

Errors use the standard error envelope. Use request_id when contacting support.