Skip to main content
POST
/
extractors
/
sources
/
byids
Retrieve Source Systems
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/extractors/sources/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>",
      "tags": [
        "<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

List of source systems to retrieve.

List of externalIds with optional ignore unknown ids

​
items
Items · object[]
required
​
ignoreUnknownIds
boolean

Response

List of source systems.

List of source systems

​
items
SourceSystem · object[]
required
Last modified on April 23, 2026