OMomni
Folders

Get folder

Changed on

Retrieve a single folder by its ID. Owner and permission information is returned separately by the Get folder permissions endpoint.

The calling user must have access to the specified folder or the API will return an error.

get/v1/folders/{folderId}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/folders/{folderId}
  • Auth
    HTTP bearer

Path parameters

folderIdstring uuid required

The UUID of the folder to retrieve. Use the List folders endpoint to retrieve folder IDs.

Query parameters

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Response

The requested folder

idstring uuid required

Unique identifier for the folder

namestring required

Display name of the folder

pathstring required

Full path to the folder, including parent folders

urlstring required

URL to view the folder in Omni

breadcrumbRootboolean required

Whether breadcrumbs for content in this folder start here

labelsstring[] required

Labels applied to the folder

Changes