JavaScript SDK

const files = await client.files.list({filter: {mimeType: 'image/png'}});

{
  "items": [
    {
      "name": "<string>",
      "id": 4503599627370496,
      "uploaded": true,
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "externalId": "my.known.id",
      "directory": "<string>",
      "source": "<string>",
      "mimeType": "image/jpeg",
      "metadata": {},
      "assetIds": [
        4503599627370496
      ],
      "dataSetId": 4503599627370496,
      "sourceCreatedTime": 1730204346000,
      "sourceModifiedTime": 1730204346000,
      "securityCategories": [
        4503599627370496
      ],
      "labels": [
        {
          "externalId": "my.known.id"
        }
      ],
      "geoLocation": {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            123
          ]
        },
        "properties": {}
      },
      "uploadedTime": 1730204346000,
      "instanceId": {
        "space": "<string>",
        "externalId": "<string>"
      }
    }
  ],
  "nextCursor": "<string>"
}

List files

Required capabilities: filesAcl:READ

The GET /files operation can be used to return information for all files in a project.

Optionally you can add one or more of the following query parameters. The filter query parameters will filter the results to only include files that match all filter parameters.

Request throttling

This endpoint is intended for data analytics and exploration purposes. It is not designed to support high-throughput data retrieval. Please note that this endpoint is subject to the new throttling policy, which imposes limits on both request rate and concurrency. For more details, please refer to the Files resource documentation.

GET

/

files

JavaScript SDK

const files = await client.files.list({filter: {mimeType: 'image/png'}});

{
  "items": [
    {
      "name": "<string>",
      "id": 4503599627370496,
      "uploaded": true,
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "externalId": "my.known.id",
      "directory": "<string>",
      "source": "<string>",
      "mimeType": "image/jpeg",
      "metadata": {},
      "assetIds": [
        4503599627370496
      ],
      "dataSetId": 4503599627370496,
      "sourceCreatedTime": 1730204346000,
      "sourceModifiedTime": 1730204346000,
      "securityCategories": [
        4503599627370496
      ],
      "labels": [
        {
          "externalId": "my.known.id"
        }
      ],
      "geoLocation": {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            123
          ]
        },
        "properties": {}
      },
      "uploadedTime": 1730204346000,
      "instanceId": {
        "space": "<string>",
        "externalId": "<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.

Query Parameters

limit

integer

default:100

Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.

Required range: 1 <= x <= 1000

cursor

string

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.

Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

name

string

Name of the file.

Maximum string length: 256

mimeType

string

File type. E.g. text/plain, application/pdf, ..

Maximum string length: 256

Example:

"image/jpeg"

source

string

The source of the file.

Maximum string length: 128

assetIds

integer<int64>[]

Only include files that reference these specific asset IDs.

Required array length: 1 - 100 elements

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991

Example:

[
  363848954441724,
  793045462540095,
  1261042166839739
]

assetExternalIds

string<jsonArray(string)>

Asset external IDs of related equipment that this file relates to. Takes 1..100 unique items.

dataSetIds

(DataSetInternalId · object | DataSetExternalId · object)[]

DataSetInternalId
DataSetExternalId

Show child attributes

rootAssetIds

string<jsonArray(int64)>

Only include files that have a related asset in a tree rooted at any of these root assetIds.

Example:

"[1238712837, 238712361376, 23786237623]"

assetSubtreeIds

string<jsonArray(int64)>

Only include files that have a related asset in a subtree rooted at any of these assetIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.

Example:

"[1238712837, 238712361376, 23786237623]"

assetSubtreeExternalIds

string<jsonArray(string)>

Only include files that have a related asset in a subtree rooted at any of these assetExternalIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.

minCreatedTime

integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

maxCreatedTime

integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

minLastUpdatedTime

integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

maxLastUpdatedTime

integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

minUploadedTime

integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

maxUploadedTime

integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

minSourceCreatedTime

integer<int64>

Include files that have sourceCreatedTime set and with minimum this value. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

maxSourceCreatedTime

integer<int64>

Include files that have sourceCreatedTime set and with maximum this value. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

minSourceModifiedTime

integer<int64>

Include files that have sourceModifiedTime set and with minimum this value. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

maxSourceModifiedTime

integer<int64>

Include files that have sourceModifiedTime set and with maximum this value. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

externalIdPrefix

string

Filter by this (case-sensitive) prefix for the external ID.

Maximum string length: 255

Example:

"my.known.prefix"

space

string

Required string length: 1 - 43

Pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$

instanceExternalIdPrefix

string

Filter by this (case-sensitive) prefix for the external ID.

Maximum string length: 255

Example:

"my.known.prefix"

uploaded

boolean

Whether or not the actual file is uploaded. This field is returned only by the API, it has no effect in a post body.

partition

string

Splits the data set into N partitions. The attribute is specified as a "M/N" string, where M is a natural number in the interval of [1, N]. You need to follow the cursors within each partition in order to receive all the data.

The maximum number of allowed partitions (N) is 10.

Cognite rejects requests if you specify more than 10 partitions. When Cognite enforces this behavior, the requests result in a 400 Bad Request status.

Example:

"1/3"

Response

The response for a successful files/list operation

A list of objects along with possible cursors to get the next page of results

items

object[]

Show child attributes

nextCursor

string

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

Last modified on April 23, 2026

Retrieve a file by its ID

⌘I