Skip to main content
POST
/
processes
/
signals
/
list
List signals.
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sink": {
    "type": "email",
    "externalId": "my.known.id"
  },
  "topic": "cognite_workflows",
  "cursor": "<string>",
  "limit": 100
}
'
{
  "items": [
    {
      "topic": "cognite_integrations",
      "sink": {
        "type": "email",
        "externalId": "my.known.id"
      },
      "externalId": "my.known.id",
      "severity": "info",
      "resourceId": "<string>",
      "category": "<string>",
      "metadata": {
        "extractorExternalId": "<string>",
        "extractorVersion": "<string>"
      },
      "message": "<string>",
      "details": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

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

Filter for signals to list.

Filter for signals to list.

sink
EmailSinkId · object
required

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

topic
enum<string>

Topic name

Available options:
cognite_workflows,
cognite_integrations,
cognite_hosted_extractors
cursor
string

Cursor for pagination. This cursor is temporary hence should not be saved.

limit
integer
default:100

Maximum number of subscriptions to return.

Required range: 1 <= x <= 100

Response

A list of signals available for the sink.

List of signals.

items
SignalRead · object[]
required
Maximum array length: 1000
nextCursor
string

Cursor for retrieving the next page of results. Omitted if there are no more results.

Last modified on April 23, 2026