Roles

Get Role

One role, with the full permission list it grants.

get/roles/{role_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/roles/{role_id}
  • Auth: HTTP bearer

Path parameters

role_idstring required

Role id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataOrgPayload required

An open envelope for a single role, team, member or account record.

Open on purpose. The app's own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as "they do not have it".

Changes

No recorded changes to this operation across all 2 revisions of this API.