Skip to main content
GET
Get a folder and its contents

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

id
integer
required

Folder ID

Query Parameters

Only files whose name contains this text

mime
string

Only files of this MIME type. A trailing wildcard matches a family, e.g. image/*.

kind
enum<string>

Only files of this kind

Available options:
image,
pdf,
document,
spreadsheet,
presentation
tag_ids[]
integer[]

Only files carrying any of these tags

created_by
integer

Only files created by this user ID

expiring_within_days
integer

Only files with an expiry date within this many days

updated_since
string<date-time>

Only files updated at or after this time

updated_before
string<date-time>

Only files updated before this time

sort
enum<string>
default:name

File sort field. Sub-folders sort by name or updated_at.

Available options:
name,
updated_at,
size_bytes,
created_at
direction
enum<string>
default:asc
Available options:
asc,
desc
include_folders
boolean
default:true

Set to 0 on later pages to skip the sub-folders

page
integer
default:1
per_page
integer
default:100

Files per page (max 500)

Required range: x <= 500

Response

Folder with contents

data
object