OMomniapp
Folders

Get a folder

Changed on

Get a folder by ID. Returns the folder's identifiers and the fields the API can set; owner and access are returned by GET /api/v1/folders/{folderId}/permissions. Returns 404 when the folder does not exist or the caller cannot view it.

get/api/v1/folders/{folderId}

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/{folderId}
  • Auth
    HTTP bearer

Path parameters

folderIdstring uuid required

Unique identifier for the folder

Example:550e8400-e29b-41d4-a716-446655440000

Query parameters

userIdstring uuid

Target user ID (for org-scoped API keys)

Response

The folder

breadcrumbRootboolean required

Whether breadcrumbs for content in this folder start here

idstring uuid required

Folder ID

labelsstring[] required

Labels on the folder

namestring required

Display name of the folder

pathstring required

Full path to the folder, including its parent folders

urlstring required

URL to view the folder in the Omni UI.

Example response

{
  "name": "Q1 Reports",
  "path": "sales-reports/q1-reports",
  "url": "https://org.omni.co/f/sales-reports/q1-reports"
}

Changes