curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sinks/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"type": "email",
"externalId": "my.known.id"
}
],
"ignoreUnknownIds": false
}
'{
"items": [
{
"type": "email",
"externalId": "my.known.id",
"emailAddress": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
]
}Required capabilities:
subscribeSignalsAcl:READ
Retrieve one or more sinks by their external IDs.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sinks/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"type": "email",
"externalId": "my.known.id"
}
],
"ignoreUnknownIds": false
}
'{
"items": [
{
"type": "email",
"externalId": "my.known.id",
"emailAddress": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Sinks to retrieve.
1 - 100 elementsReference to a sink. If the type is "user", the user must exist in the user profiles API.
Show child attributes
Ignore external IDs that are not found
Retrieved sinks.
1 - 100 elementsDescription of an e-mail sink.
Show child attributes
Was this page helpful?