Skip to main content
GET
/
projects
/
{projectIdOrName}
/
destinations
List destinations
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/destinations \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": "<string>",
    "name": "leadConvertedWebhook",
    "type": "webhook",
    "metadata": {
      "url": "https://webhooks.mailmonkey.com/salesforce-lead-converted",
      "headers": {
        "Authorization": "Bearer 1234"
      },
      "streamName": "my-data-stream",
      "region": "us-east-1",
      "partitionKeyTemplate": "{{.integration_id}}"
    },
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "secrets": {
      "webhookSigningKey": "<string>"
    }
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

Response

List of destinations

​
id
string
required

The destination ID.

​
name
string
required

User-defined name for the destination

Example:

"leadConvertedWebhook"

​
type
string
required

The type of the destination

Example:

"webhook"

​
metadata
object
required
​
createTime
string<date-time>
required

The time the destination was created.

​
updateTime
string<date-time>

The time the destination was updated.

​
secrets
object

Destination secrets (only included when includeSecrets is true)