v1

latestOpenAPI 3.1.12026-07-124448163.2 KB

files

List files

Returns a paginated list of files with optional workspace filters.

get/files

Query parameters

limitnumber

The number of items to return

Example:20

cursorstring cuid

The cursor to return the next page of items

Example:cmf41ajzv003706un4i99q19z

workspaceIdstring cuid

Headers

x-client-idstring cuid required

The ID of the client

Example:cmf41ajzv003706un4i99q19z

Response

Paginated files

Example response

{
  "data": [
    {
      "id": "cmf41ajzv003706un4i99q19z",
      "documentDate": "2021-01-01T00:00:00Z",
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z",
      "name": "document.pdf",
      "mimetype": "application/pdf",
      "size": 1024,
      "workspaceId": "cmf41ajzv003706un4i99q19z",
      "createdById": "cmf41ajzv003706un4i99q19z",
      "taskId": "cmf41ajzv003706un4i99q19z",
      "folderId": "cmf41ajzv003706un4i99q19z",
      "labelIds": [
        "cmf41ajzv003706un4i99q19z"
      ]
    }
  ],
  "pagination": {
    "nextCursor": "cmf41ajzv003706un4i99q19z",
    "previousCursor": "cmf41ajzv003706un4i99q19z",
    "limit": 20,
    "total": 134
  }
}