Documents

List documents

Changed on Oct 23, 2026

get/api/v1/documents

Request

Base URL
https://omniapp.co (the document declares no server; this is the origin it was published from)
URL
https://omniapp.co/api/v1/documents
Auth
HTTP bearer

Query parameters

cursorstring

Cursor for pagination (from previous response nextCursor)

Example:eyJpZCI6IjEyMzQ1In0

pageSizeinteger

Number of results per page (1-100, integer)

Example:20

sortDirection'asc' | 'desc'

Sort direction for results

Example:desc

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

Field to sort by

creatorIdstring uuid

Filter by creator user ID

folderIdstring uuid

Filter by folder ID

includestring

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

Example:_count,labels

labelsstring

Comma-separated list of label names to filter by

Example:verified,important

userIdstring uuid

Filter documents visible to this user ID

Response

Paginated list of documents

Example response

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

Changes

Oct 23, 2026451edd7156a2 Revision changes
- breaking
  the response's property type changed from no type to object for status
- breaking
  the /// response's property type changed from string to no type for status
- breaking
  removed the required property // from the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added subschema #2 to the /// response property allOf list for the response status
- info
  removed subschema #2 from the response property allOf list for the response status
- info
  the response property // became required for the status
- info
  removed the organization enum value from the /// response property for the response status
- info
  removed the restricted enum value from the /// response property for the response status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Sep 15, 2026febf0a61f153 Revision changes
- breaking
  for the query request parameter pageSize, default value was changed from 50 to 20
- breaking
  for the query request parameter sortDirection, default value was changed from asc to desc
- warning
  for the query request parameter pageSize, the max was set to 100.00
- warning
  for the query request parameter pageSize, the min was set to 1.00
- info
  added the new enum value lastViewedAt to the query request parameter sortField

Operation history