List files

v1.0.0

Lists internal files, externally connected files and folders for a specific record. Use the object and record_id query parameters to specify the record. Optional query parameters may be provided to filter results by storage provider or parent folder.

This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users.

Required scopes: object_configuration:read, record_permission:read, file:read.

Input

{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "description": "A pagination cursor used to fetch the next page of files. Responses with more files will include a cursor for you to use here. If not provided, the first page will be returned."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of files to return. Must be between 1 and 200. Defaults to 50."
    },
    "object": {
      "type": "string",
      "description": "The object slug or ID."
    },
    "parent_folder_id": {
      "type": "string",
      "format": "uuid",
      "description": "Filter by parent folder ID. Each file entry has provided optioanl parent_folder_id that can be used to filter results by folder. When omitted, entries at all nesting levels are returned."
    },
    "record_id": {
      "type": "string",
      "format": "uuid",
      "description": "The record ID for the specific record whose files you want to list."
    },
    "storage_provider": {
      "type": "string",
      "description": "Filter results by storage provider.",
      "enum": [
        "attio",
        "dropbox",
        "box",
        "google-drive",
        "microsoft-onedrive"
      ]
    }
  },
  "required": [
    "object",
    "record_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "pagination": {
      "type": "object",
      "required": [
        "next_cursor"
      ],
      "properties": {
        "next_cursor": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}