Skip to main content
POST
/
labels
/
list
JavaScript SDK
const labels = await client.labels.list({ filter: { externalIdPrefix: 'Pu'}});
{
  "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

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

filter
Filter · object

Filter on labels definitions with strict matching.

cursor
string
Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

limit
integer
default:100

Limits the number of results to return.

Required range: 1 <= x <= 1000

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