← API referenceBrowse & search · API access unavailable
API REFERENCE / FOLDERS
GET /v1/folders/{folder_id}/children
List one visible folder’s immediate files and subfolders. Like GET /v1/roots, this accepts limit, sort, and an opaque cursor, and returns items plus next_cursor. Default sorting is name_asc; modified_desc is also available. Each page is a live view, not a frozen inventory.
Request fields
| Location | Field | Type | Required | Description |
|---|---|---|---|---|
| Header | Authorization | string | Yes | Credential scoped to the authorized resource. |
| Path | folder_id | string | Yes | Visible folder ID from a root or prior children page. |
| Query | limit | integer | No | Page size, 1–200; defaults to 100. |
| Query | sort | string (enum) | No | name_asc (default) or modified_desc. Allowed values · closed enum name_ascmodified_desc |
| Query | cursor | string | No | Opaque next-page cursor bound to this folder, caller, and sort order. |
Request example
Example request
GET /v1/folders/folder_123/children?limit=100&sort=name_asc
Authorization: Bearer <scoped token>HTTP status codes
| Status | Meaning |
|---|---|
200 OK | Success response shown below. |
400 Bad Request | Invalid limit, sort, or pagination cursor. |
401 Unauthorized | Missing, expired, or invalid credential. |
403 Forbidden | Credential is valid but lacks the required scope or role. |
404 Not Found | Folder does not exist or is not visible to this caller. |
410 Gone | Pagination cursor expired; restart this folder listing. |
429 Too Many Requests | Rate limit reached; honor Retry-After when provided. |
503 Service Unavailable | Service temporarily unavailable; retry safely. |
Response fields
| Field | Type | Example |
|---|---|---|
items | object[] | [2 shown] |
items[].id | string | file_789 |
items[].type | string (enum) | file Allowed values · closed enum filefolder |
items[].name | string | invoice.pdf |
items[].modified_at | string (date-time) | 2026-10-20T18:00:00Z |
items[].version_id | string | ver_012 |
items[].availability | string | available |
next_cursor | string | null | null |
Response example
Example response
200 OK
Content-Type: application/json
{
"items": [
{
"id": "file_789",
"type": "file",
"name": "invoice.pdf",
"modified_at": "2026-10-20T18:00:00Z",
"version_id": "ver_012",
"availability": "available"
},
{
"id": "folder_124",
"type": "folder",
"name": "Receipts",
"modified_at": "2026-10-19T18:00:00Z"
}
],
"next_cursor": null
}