Organization Roles

Retrieve an organization role

Changed on

Use this request to retrieve an existing organization role by its ID.

get/organization_roles/{organization_role_id}

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/organization_roles/{organization_role_id}
  • Auth: HTTP bearer

Path parameters

organization_role_idstring required

The ID of the organization role

Response

Success

object'role' required
idstring required
namestring required
keystring required
descriptionstring nullable required
is_creator_eligibleboolean required

Whether this role is eligible to be an organization creator role

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Changes