Skip to main content
POST
/
labels
/
byids
Python SDK
res = client.labels.retrieve(external_id="my_label", ignore_unknown_ids=True)
{
  "items": [
    {
      "externalId": "my.known.id",
      "name": "<string>",
      "createdTime": 1730204346000,
      "description": "<string>",
      "dataSetId": 4503599627370496
    }
  ],
  "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
​
items
Select by ExternalId · object[]
required
Required array length: 1 - 1000 elements
​
ignoreUnknownIds
boolean
default:false

Ignore IDs and external IDs that are not found

Response

A list of label definitions.

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

The cursor to get the next page of results (if available).

Last modified on April 23, 2026