Sign in

v1

latestOpenAPI 3.1.02026-07-1283362.8 KB
Files

List Files

get/unified/documents/files

Query parameters

rawboolean nullable

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxyobject nullable

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fieldsstring nullable
Example:id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

updated_afterstring date-time nullable

Use a string with a date to only select results updated after that given date

namestring nullable

Search if the name of the file contains the string

contentstring nullable

Search if the contents of the file contains the string (contents can include file metadata)

created_afterstring date-time nullable

Use a string with a date to only select results created after that given date

drive_idstring nullable

Use to only include Files within the specified Drive

folder_idstring nullable

Use to only include Files within the specified Folder. Required when requesting nested items

Documents Files Filter

{
  "updated_after": "2020-01-01T00:00:00.000Z",
  "name": "john_doe_resume.pdf",
  "content": "FAQ of the project",
  "created_after": "2020-01-01T00:00:00.000Z",
  "drive_id": "1234567890",
  "folder_id": "1234567890"
}
pagestring nullable

The page number of the results to fetch

page_sizestring nullable

The number of results per page (default value is 25)

nextstring nullable

The unified cursor

updated_afterstring date-time nullable
Example:2020-01-01T00:00:00.000Z

Use a string with a date to only select results updated after that given date

folder_idstring nullable
Example:1234567890

Use to only include Files within the specified Folder. Required when requesting nested items

nested_itemsstring nullable
Example:true

When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders

includestring nullable
Example:all_parent_folder_ids

The comma separated list of fields that will be included in the response

Headers

x-account-idstring required

The account identifier

x-stackone-api-session-tokenstring

The session token

Preferstring
Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Response

The list of files was retrieved.

nextstring nullable

Example response

{
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Information-Technology",
      "description": "This is the description associated to the file.",
      "size": 1024,
      "url": "https://drive.google.com/file/d/nd8932h9d/view",
      "file_format": {
        "value": "pdf"
      },
      "path": "/path/to/file",
      "owner_id": "c28xyrc55866bvuv",
      "export_formats": [
        "application/pdf"
      ],
      "default_download_format": "application/pdf",
      "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "folder_id": "c28xyrc55866bvuv",
      "remote_folder_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "drive_id": "c28xyrc55866bvuv",
      "remote_drive_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "created_at": "2023-02-23T00:00:00.000Z",
      "updated_at": "2024-02-23T00:00:00.000Z",
      "all_parent_folder_ids": [
        "0123456789"
      ]
    }
  ]
}