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

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Query Parameters

​
labels
string

Filter content by labels. Provide as a comma-separated list (e.g., finance,marketing).

​
scope
enum<string>
default:organization

Content scope filter

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

Field to sort by

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

Direction for sorting:

  • asc - Ascending order (A-Z, 0-9)
  • desc - Descending order (Z-A, 9-0)
Available options:
asc,
desc
​
include
string

Comma-separated list of additional fields to include in the response:

  • _count - Adds count metrics (folders: document and favorite counts; documents: favorite and view counts)
  • labels - Includes associated content labels
​
folderId
string<uuid>

Returns all content in the specified folder. Cannot be used with path.

​
path
string

Filter content by path. Cannot be used with folderId. Examples:

  • /folder/subfolder - Returns the folder and any content it contains
  • /folder/* - Returns all folders and content recursively in the path
  • / - Returns all content in the organization
​
creatorId
string<uuid>

UUID of organization membership. Required when scope is restricted.

​
pageSize
integer
default:20

Number of records per page (1-100)

Required range: 1 <= x <= 100
​
cursor
string

Pagination cursor from previous response

Response

Paginated content list

​
records
object[]
​
pageInfo
object

Pagination information for paginated responses.