OMomniapp
Folders

List folders

Changed on
get/api/v1/folders

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/folders
  • 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' | 'path'

Field to sort by

labelsstring

Comma-separated list of labels to filter by

includestring

Comma-separated list of fields to include (_count, labels, onlyFavorites, onlySharedWithMe). onlyFavorites returns only folders the user has favorited and can access; onlySharedWithMe returns only folders shared with the user. The two cannot be combined with each other, ownerId or path, and when used with org-scoped API keys require the userId query parameter. For user-scoped keys (PAT), userId is auto-inferred from the token.

Example:_count,labels
ownerIdstring uuid

Filter by owner user ID

pathstring

Filter by folder path; a trailing * or ** is a wildcard

scope'organization' | 'restricted'

Filter by share scope

userIdstring uuid

User ID. Only used with the onlyFavorites and onlySharedWithMe include fields. Required for org-scoped API keys; auto-inferred from the token for user-scoped keys (PAT).

Response

Paginated list of folders

Example response

{
  "records": [
    {
      "name": "My Reports",
      "path": "sales-reports/q1-2026",
      "url": "https://org.omni.co/f/sales-reports"
    }
  ]
}

Changes

  • 451edd7156a2Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the // response's property format changed from uuid to no format for status

    • breaking

      removed the required property // from the response with the status

    • info

      removed subschema #2 from the response property allOf list 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

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • f9d898b7238cRevision changes
    • breaking

      added the pattern ^\s*((_count|labels|onlyFavorites|onlySharedWithMe)\s*)?(,\s*((_count|labels|onlyFavorites|onlySharedWithMe)\s*)?)*$ to the query request parameter include