KOkontainer
DAM: Folders: Usergroup Permissions

Returns a list of folder usergroup permissions

Retrieve Folder Usergroup Permissions

Endpoint for retrieving permissions for user groups on a specific folder.

get/dam/folders/{folder_id}/user-groups/permissions

Request

Path parameters

folder_idstring required

ID of Folder

Query parameters

page[number]number

Requested page number (defaults to 1)

page[size]number

Requested page size (defaults to 100)

filter[given_permission][eq]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by given permission (equals)

filter[given_permission][gt]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by given permission (greater than)

filter[given_permission][gte]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by given permission (greater than or equal)

filter[given_permission][lte]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by given permission (less than or equal)

filter[given_permission][lt]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by given permission (less than)

filter[inherited_user_group_permission][eq]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by inherited user group permission (equals)

filter[inherited_user_group_permission][gt]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by inherited user group permission (greater than)

filter[inherited_user_group_permission][gte]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by inherited user group permission (greater than or equal)

filter[inherited_user_group_permission][lte]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by inherited user group permission (less than or equal)

filter[inherited_user_group_permission][lt]'none' | 'inherit' | 'read' | 'download' | 'write' | 'delete'

Filter by inherited user group permission (less than)

Response

success

Example response

{
  "data": [
    {
      "type": "folder_user_group_permission",
      "id": "abc123",
      "attributes": {
        "given_permission": "read",
        "inherited_user_group_permission": "write"
      },
      "meta": {
        "folder_id": 1234,
        "user_group_id": 5678,
        "scheduled_permissions": [
          {
            "release_date_id": 42,
            "given_permission": "write",
            "release_at": "2026-12-24T07:00:00Z"
          }
        ]
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "Previous",
        "active": false
      },
      {
        "url": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next",
        "active": false
      }
    ],
    "path": "https://example.kontainer.com/jsonapi/v2/dam/folders",
    "per_page": 500,
    "to": 1,
    "total": 1,
    "sort": "name"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.