List Folders

curl --request GET \
  --url https://api.stackone.com/unified/documents/folders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "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 folder.",
      "size": 1024,
      "url": "https://drive.google.com/folder/d/nd8932h9d/view",
      "path": "/path/to/folder",
      "owner_id": "c28xyrc55866bvuv",
      "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "parent_folder_id": "c28xyrc55866bvuv",
      "remote_parent_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",
      "has_content": true,
      "has_children": true,
      "is_root": true,
      "all_parent_folder_ids": [
        "0123456789"
      ]
    }
  ],
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

documents

folders

List Folders

curl --request GET \
  --url https://api.stackone.com/unified/documents/folders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "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 folder.",
      "size": 1024,
      "url": "https://drive.google.com/folder/d/nd8932h9d/view",
      "path": "/path/to/folder",
      "owner_id": "c28xyrc55866bvuv",
      "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "parent_folder_id": "c28xyrc55866bvuv",
      "remote_parent_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",
      "has_content": true,
      "has_children": true,
      "is_root": true,
      "all_parent_folder_ids": [
        "0123456789"
      ]
    }
  ],
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Query Parameters

raw

boolean | null

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

proxy

object

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

fields

string | null

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

Example:

"id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields"

filter

object

Documents Folders Filter

Show child attributes

filter[updated_after]

string<date-time> | null

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

Example:

"2020-01-01T00:00:00.000Z"

filter[drive_id]

string | null

Use to only include Folders within the specified Drive

Example:

"1234567890"

filter[folder_id]

string | null

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

Example:

"1234567890"

page

string | null

The page number of the results to fetch

page_size

string | null

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

string | null

The unified cursor

updated_after

string<date-time> | null

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

Example:

"2020-01-01T00:00:00.000Z"

folder_id

string | null

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

Example:

"1234567890"

nested_items

string | null

default:false

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

Example:

"true"

include

string | null

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

Example:

"all_parent_folder_ids"

Response

The list of folders was retrieved.

data

object[]

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.name

string | null

The name associated with this folder

Example:

"Information-Technology"

data.description

string | null

The description of the folder

Example:

"This is the description associated to the folder."

data.size

number | null

The size of this folder in bytes

Example:

1024

data.url

string | null

The url of the folder

Example:

"https://drive.google.com/folder/d/nd8932h9d/view"

data.path

string | null

The path where the folder is stored

Example:

"/path/to/folder"

data.owner_id

string | null

The user ID of owner of this folder

Example:

"c28xyrc55866bvuv"

data.remote_owner_id

string | null

Provider's unique identifier of the owner of this folder

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.parent_folder_id

string | null

The parent folder ID associated with this folder

Example:

"c28xyrc55866bvuv"

data.remote_parent_folder_id

string | null

Provider's unique identifier of the parent folder associated with this folder

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.drive_id

string | null

The parent drive ID associated with this folder

Example:

"c28xyrc55866bvuv"

data.remote_drive_id

string | null

Provider's unique identifier of the parent drive associated with this folder

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.created_at

string<date-time> | null

The created date of the folder

Example:

"2023-02-23T00:00:00.000Z"

data.updated_at

string<date-time> | null

The last updated date of the folder

Example:

"2024-02-23T00:00:00.000Z"

data.has_content

Whether the folder has content

Example:

true

data.has_children

Whether the folder has children

Example:

true

data.is_root

Whether the folder is at the root level of the drive

Example:

true

data.all_parent_folder_ids

string[] | null

List of containing parent Folder IDs in descending order

Example:

["0123456789"]

string | null

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Get File Get Folder

⌘I

Getting Started

Use Cases

API Reference

List Folders

Authorizations

Headers

Query Parameters

Response