Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Folders

List folders

get/api/v1/folders

Query parameters

cursorstring

Cursor for pagination

Cursor for pagination

includestring

Comma-separated list of fields to include (_count, labels, onlySharedWithMe). onlySharedWithMe returns only folders shared with the user, cannot be combined with ownerId or path, and when used with org-scoped API keys requires the userId query parameter. For user-scoped keys (PAT), userId is auto-inferred from the token.

Example:_count,labels

Comma-separated list of fields to include (_count, labels, onlySharedWithMe). onlySharedWithMe returns only folders shared with the user, cannot be combined with ownerId or path, and when used with org-scoped API keys requires the userId query parameter. For user-scoped keys (PAT), userId is auto-inferred from the token.

labelsstring

Comma-separated list of labels to filter by

Comma-separated list of labels to filter by

ownerIdstring uuid

Filter by owner user ID

Filter by owner user ID

pageSizenumber nullable

Number of results per page

Example:20

Number of results per page

pathstring

Filter by exact path

Filter by exact path

scope'organization' | 'restricted'

Filter by share scope

Filter by share scope

sortDirection'asc' | 'desc'

Sort direction

Sort direction

sortField'name' | 'createdAt' | 'updatedAt' | 'favorites' | 'path'

Field to sort by

Field to sort by

userIdstring uuid

User membership ID. Only used with onlySharedWithMe include field. Required for org-scoped API keys; auto-inferred from the token for user-scoped keys (PAT).

User membership ID. Only used with onlySharedWithMe include field. Required for org-scoped API keys; auto-inferred from the token for user-scoped keys (PAT).

Response

Paginated list of folders

Example response

{
  "records": [
    {
      "name": "My Reports",
      "path": "/shared/reports/my-reports",
      "url": "https://org.omni.co/f/my-reports"
    }
  ]
}