Skip to main content
GET
/
v1
/
documents
List documents
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/documents \
  --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
enum<string>

Additional fields to include

Available options:
_count,
includeDeleted
​
labels
string

Comma-separated label filter

​
pageSize
integer

Number of records per page

Required range: 1 <= x <= 100
​
sortField
enum<string>

Field to sort by

Available options:
favorites,
name,
updatedAt,
visits
​
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc
​
cursor
string

Document name for pagination

​
userId
string<uuid>

Filter by user access

​
creatorId
string<uuid>

Filter by creator

Response

Paginated document list

​
records
object[]
​
pageInfo
object