Skip to main content
GET
/
v1
/
folders
/
{folderId}
/
permissions
Get folder permissions
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions \
  --header 'Authorization: Bearer <token>'
{
  "permits": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "user",
      "direct": {
        "accessBoost": true,
        "isOwner": true,
        "role": "NO_ACCESS"
      }
    }
  ]
}

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

Path Parameters

​
folderId
string<uuid>
required

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

Query Parameters

​
userId
string<uuid>
required

The ID of the user to retrieve folder permissions for. Use the List users or List embed users endpoints to retrieve user IDs.

Response

Folder permissions object

​
permits
object[]