OPopenintake
Admin

Get Roles

Changed on

The built-in Admin and Staff roles, then the firm's custom roles by name. Requires staff.manage.

get/admin/roles

Request

  • Base URL
    https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.openintake.ai/admin/roles
  • Auth
    none declared

Response

Successful Response

idstring required

'admin' or 'staff' for a built-in role, otherwise the custom role's id

namestring required
descriptionstring nullable
built_inboolean required
permissionsPermission[] required

Everything the role holds

user_countinteger required

Changes

  • ceeae5525826Revision changes
    • info

      removed the calls.feedback enum value from the // response property for the response status

  • 6cf2cbf46fe1Revision changes
    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status