Organization Roles

Get an organization membership or invitation by ID

Retrieve one organization membership or invitation using its role record ID. Returns the permission, membership status, invitation details and timestamps; include can expand the organization and user. The caller may read their own membership, or another member's role when they can manage the organization and their assistant grant permits write access. This lookup does not accept an invitation, change permissions or send a notification.

get/organization-roles/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/organization-roles/{id}
  • Auth: none declared

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:organization

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; max 10 paths. Allowed paths: organization, user.

Response

Successful. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": {
    "type": "organization_role"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.