Skip to main content
POST
/
workspace-roles
Create a workspace role
curl --request POST \
  --url https://www.ruddr.io/api/workspace/workspace-roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "isActive": true,
  "isBillable": true,
  "rate": 123,
  "currency": "<string>",
  "practiceId": "<string>",
  "locationId": "<string>",
  "disciplineId": "<string>"
}
'
{
  "id": "a3f1c2e4-8b47-4d9e-b6f2-3c7a5d1e9f04",
  "name": "Senior Engineer",
  "isActive": true,
  "isBillable": true,
  "rate": 175,
  "currency": "USD",
  "createdAt": "2025-03-12T14:22:38.104Z",
  "practice": {
    "id": "9e4b7c1a-2f63-4a8d-b5e0-7d2c6f3a1b89",
    "name": "Engineering"
  },
  "location": {
    "id": "c8d2f5b3-6e14-4c7a-a9b1-2e8f4d6c0a35",
    "name": "New York"
  },
  "discipline": {
    "id": "5a7e3d9b-1c42-4f6e-8a0d-4b9c2e7f5a13",
    "name": "Software Development"
  }
}
A company-wide role and rate used to build a rate card. Workspace roles can be added or linked to client-specific rate cards.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the workspace role. Maximum 255 characters.

isActive
boolean

Whether the workspace role is active. Defaults to true if not provided.

isBillable
boolean

Whether the workspace role is billable. Defaults to true if not provided.

rate
number

The billing rate for the workspace role.

currency
string

The 3-letter currency code for the workspace role. Defaults to the workspace currency if not provided.

practiceId
string

The unique identifier for the practice to associate with this workspace role.

locationId
string

The unique identifier for the location to associate with this workspace role.

disciplineId
string

The unique identifier for the discipline to associate with this workspace role.

Response

200

id
string

The unique identifier for the object.

name
string

The name of the workspace role.

isActive
boolean

Whether the workspace role is active.

isBillable
boolean

Whether the workspace role is billable.

rate
number | null

The billing rate for the workspace role. null when isBillable is false.

currency
string | null

The 3-letter currency code for the workspace role. null when isBillable is false.

createdAt
string<date-time>

The timestamp when the object was created.

practice
object

The practice associated with this workspace role, if any.

location
object

The location associated with this workspace role, if any.

discipline
object

The discipline associated with this workspace role, if any.