Skip to main content
GET
/
v3
/
permissions
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/permissions \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "domain": "<string>",
        "object": "<string>",
        "action": "<string>",
        "name": "<string>",
        "description": "<string>",
        "available_scopes": {
          "attributes": [
            {
              "name": "<string>",
              "type": "uuid",
              "operations": [
                "="
              ],
              "resource_type": [
                "folders",
                "users"
              ]
            }
          ],
          "patterns": [
            {
              "type": "contains",
              "field": "<string>",
              "operations": [
                "="
              ]
            }
          ]
        }
      },
      "relationships": {
        "additional_permissions": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "jsonapi": {
    "version": "<string>"
  },
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of permissions

Document level meta about the resources on the server in list endpoints.

data
A list of permissions · object[]
required
jsonapi
object
required
meta
object
required