Get a Role

get

https://api.wingspan.app/v3/platform/roles/{roleId}

Retrieve a single Role by ID, including its scope set and whether it is a system or custom role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

roleId

string

required

^(role_[a-zA-Z0-9_-]+|[A-Z][a-z0-9]+(?:[A-Z][a-z0-9]+)*)$

Role identifier. System roles use PascalCase ids (for example Admin or PayableManager); custom roles use role_<id>. The old system role ids role_admin and role_officer are accepted and resolve to Admin.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Role detail

401Unauthenticated

403Forbidden

404Resource not found