GEgetkisi
Roles

Fetch role

Changed on
get/roles/{id}

Request

  • Base URL
    https://api.kisi.io
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://api.kisi.io/oauth/authorize
      Token URLhttps://api.kisi.io/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The ID of the object

Response

OK

idstring required
resource_type'Role' required

The resource type of the role

applies_to'Organization' | 'Place' | 'Group' required
namestring required
descriptionstring nullable required
customboolean required
custom_role_idinteger nullable required

The custom_role ID of the role

Changes

  • f84bf70ab13dRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status