Q2 2025 Roadmap: Request a beta API key and access upcoming features: Embedded Notifications, Team Communications and more.

Retrieve a specific role

GET

/api/organizations/{organization_id}/roles/{id}

roles

Retrieves the details of a specific role by its ID.

Response Example

200 - Success

{
  "id": "role_001",
  "name": "Manager",
  "organizationId": "org_12345",
  "hourlyWage": 25,
  "active": true,
  "createdAt": "2023-10-27T09:00:00Z",
  "updatedAt": "2023-10-27T09:00:00Z",
  "deletedAt": null
}

Request

Path Params

organization_id

string

required

The unique identifier of the organization to which the role belongs.

Example:

org_12345

string

required

The unique identifier of the role to retrieve.

Example:

role_001

Responses

🟢200OK

application/json

The details of the requested role.

Body

active

boolean

required

createdAt

string <date-time>

required

deletedAt

string <date-time> | null

required

hourlyWage

number | null

required

string

required

name

string

required

organizationId

string

required

updatedAt

string <date-time>

required

🟠404Record Not Found

Retrieve all roles

Update a specific role