Skip to main content
POST
/
processes
/
signals
/
sinks
/
byids
Retrieve sinks by 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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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.

Body

application/json

Sinks to retrieve.

​
items
(EmailSinkId · object | UserSinkId · object | CurrentUserSinkId · object)[]
required
Required array length: 1 - 100 elements

Reference to a sink. If the type is "user", the user must exist in the user profiles API.

​
ignoreUnknownIds
boolean
default:false

Ignore external IDs that are not found

Response

Retrieved sinks.

​
items
(EmailSinkWrite · object | UserSinkWrite · object)[]
required
Required array length: 1 - 100 elements

Description of an e-mail sink.

Last modified on April 23, 2026