CorefinityCorefinityDocs
Open the Control PanelControl Panel
Team · 13 of 17

List roles and their permissions

Answers your company's custom roles and the standard roles for your kind of company, by name, each with the permissions it gives and whether you may give it to somebody.

GET/api/team/roles

Returns

200 The roles.

Fields of the 200 answer
dataobjectRequired
Fields
rolesarray of objectsRequired
Fields of each item
assignablebooleanRequired

Whether you may give this role to somebody in your company.

custombooleanRequired

True for a role your company made; false for a standard role.

idintegerRequired

At least 1.

namestringRequired
permissionsarray of stringsRequired

The slugs of the permissions the role gives.

slugstringRequired

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/team/roles \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "data": {
    "roles": [
      {
        "assignable": true,
        "custom": false,
        "id": 3012,
        "name": "Member (Full Access)",
        "permissions": [
          "viewWebsites",
          "viewDeployments",
          "viewTickets",
          "createTickets"
        ],
        "slug": "client-member-full"
      },
      {
        "assignable": true,
        "custom": true,
        "id": 3107,
        "name": "Release managers",
        "permissions": [
          "viewUsers"
        ],
        "slug": "release-managers-0b9c7a52-3f7e-4c1d-9a55-2f6f1f0e8d11"
      }
    ]
  }
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT