Skip to main content
POST
/
extractors
/
byids
Retrieve Extractors
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/extractors/byids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "externalId": "my.known.id"
    }
  ],
  "ignoreUnknownIds": true
}
'
{
  "items": [
    {
      "externalId": "my.known.id",
      "name": "<string>",
      "description": "<string>",
      "type": "global",
      "documentation": "<string>",
      "imageUrl": "<string>",
      "latestVersion": "<string>",
      "links": [
        {
          "name": "<string>",
          "type": "generic",
          "url": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ]
    }
  ]
}

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.

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

List of externalIds with optional ignore unknown ids

items
Items · object[]
required
ignoreUnknownIds
boolean

Response

List of extractors.

List of extractors

items
Extractor · object[]
required
Last modified on May 13, 2026