Skip to main content
GET
/
workers
/
{id}
/
credentials
Get Worker Credentials
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/workers/{id}/credentials \
  --header 'X-API-KEY: <api-key>'
{
  "credentials": [
    {
      "id": "<string>",
      "personnel_id": 123,
      "credentials_id": "<string>",
      "submitter_id": 123,
      "submitter_name": "<string>",
      "date_completed": "<string>",
      "date_completed_nice": "<string>",
      "date_expired": "<string>",
      "date_expired_nice": "<string>",
      "date_submitted": "<string>",
      "date_submitted_nice": "<string>",
      "file_location_value": "<string>",
      "file_name": "<string>",
      "file_display_name": "<string>",
      "clients_id": "<string>",
      "client_name": "<string>",
      "locations_id": "<string>",
      "location_name": "<string>",
      "deleted": 0,
      "company_id": 123,
      "name": "<string>",
      "description": "<string>",
      "expiring_inform": 0,
      "expiring_inform_period": 123,
      "expiring_inform_hr": 0,
      "expiring_inform_hr_period": 123,
      "expired_inform": 0,
      "expired_inform_hr": 0,
      "rule_usable": 0,
      "worker_viewable": 0,
      "worker_editable": 0,
      "type": "General",
      "protected": 0,
      "course_id": 123,
      "expiration_months": 123
    }
  ],
  "total": 123
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Worker ID

Query Parameters

​
items_per_page
integer
default:25

Number of credentials per page.

Required range: x >= 1
​
page
integer
default:1

Page number to retrieve.

Required range: x >= 1
​
type
enum<string>

Filter credentials by type.

Available options:
general,
client,
venue

Response

OK

​
credentials
object[]
​
total
integer

Total number of credentials matching the filter.