Skip to main content
GET
/
skillsets
/
{id}
Get Skillset
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/skillsets/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "role_title": "<string>",
  "default_time": "13:00",
  "default_comments": "<string>",
  "default_payroll_group": "<string>",
  "on_for_new_signups": 0,
  "client_portal_access": 0
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
integer
required

Skillset ID

Response

OK

A skillset (role) that can be assigned to workers and shifts.

​
id
integer

Skillset identifier

​
role_title
string

Skillset name

​
default_time
string

Default shift start time (HH:mm)

Example:

"13:00"

​
default_comments
string | null

Default shift comments

​
default_payroll_group
string | null

Default payroll group code

​
on_for_new_signups
integer

Whether this skillset is auto-assigned to new workers (0 = no, 1 = yes)

Required range: 0 <= x <= 1
​
client_portal_access
integer

Whether this skillset is visible in the client portal (0 = no, 1 = yes)

Required range: 0 <= x <= 1