Skip to main content
GET
/
v1
/
folders
List folders
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/folders \
  --header 'Authorization: Bearer <token>'
{
  "records": [
    {}
  ],
  "pageInfo": {
    "hasNextPage": true,
    "nextCursor": "<string>",
    "pageSize": 123,
    "totalRecords": 123
  }
}

Authorizations

​
Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Query Parameters

​
include
string

Additional fields to include (e.g., "_count,labels")

​
path
string

Path pattern filter (e.g., "/documents/*")

​
labels
string[]

Label name filter

​
scope
enum<string>

Folder scope filter

Available options:
organization,
restricted
​
sortField
enum<string>

Field to sort by

Available options:
name,
path
​
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc
​
cursor
string

Base64-encoded pagination cursor

​
pageSize
integer

Number of records per page

Required range: x >= 1
​
ownerId
string<uuid>

Owner ID (required when scope is "restricted")

Response

Paginated folder list

​
records
object[]
​
pageInfo
object