Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Documents

List documents

get/api/v1/documents

Query parameters

creatorIdstring uuid

Filter by creator membership ID

Filter by creator membership ID

cursorstring

Cursor for pagination

Cursor for pagination

folderIdstring uuid

Filter by folder ID

Filter by folder ID

includestring

Comma-separated list of additional fields to include: _count, labels, includeDeleted, onlyFavorites, onlySharedWithMe. onlySharedWithMe requires userId or user-scoped key and cannot be combined with onlyFavorites or folderId.

Example:_count,labels

Comma-separated list of additional fields to include: _count, labels, includeDeleted, onlyFavorites, onlySharedWithMe. onlySharedWithMe requires userId or user-scoped key and cannot be combined with onlyFavorites or folderId.

labelsstring

Comma-separated list of label names to filter by

Example:verified,important

Comma-separated list of label names to filter by

pageSizeinteger

Number of records per page

Number of records per page

sortDirection'asc' | 'desc'

Sort direction

Sort direction

sortField'name' | 'favorites' | 'updatedAt' | 'visits'

Field to sort by

Field to sort by

userIdstring uuid

Filter documents visible to this membership ID

Filter documents visible to this membership ID

Response

Paginated list of documents

Example response

{
  "records": [
    {
      "identifier": "abc123",
      "url": "https://org.omni.co/dashboards/abc123"
    }
  ]
}