Skip to main content
GET
Get Worker Credential

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Worker ID

credentials_id
string
required

Credentials ID

Response

OK

A credential record assigned to a worker.

id
string

Personnel credential record identifier.

personnel_id
integer

Worker personnel ID.

credentials_id
string

Credential definition ID.

submitter_id
integer

ID of the user who submitted the credential.

submitter_name
string

Name of the user who submitted the credential.

date_completed
string | null

Completion date (e.g. "2023-12-03 20:00:00"). null if not set.

date_completed_nice
string | null

Formatted completion date (e.g. "Dec 3rd, 2023"). null if not set.

date_expired
string | null

Expiration date (e.g. "2023-12-04 20:00:00"). null if not set.

date_expired_nice
string | null

Formatted expiration date (e.g. "Dec 4th, 2023"). null if not set.

date_submitted
string

Submission timestamp.

date_submitted_nice
string

Formatted submission date.

file_location_value
string | null

URL to the uploaded credential file. null if no file attached.

file_name
string | null

Original file name.

file_display_name
string | null

Display file name.

clients_id
string | null

Associated client ID. null for general credentials.

client_name
string | null

Associated client name.

locations_id
string | null

Associated location/venue ID. null for general credentials.

location_name
string | null

Associated location/venue name.

deleted
enum<integer>

Soft-delete flag. 0 = active, 1 = deleted.

Available options:
0,
1
company_id
integer

Company ID.

name
string

Credential name.

description
string

Credential description.

expiring_inform
enum<integer>

Whether to notify worker before expiry. 1 = yes, 0 = no.

Available options:
0,
1
expiring_inform_period
integer

Days before expiry to notify the worker.

expiring_inform_hr
enum<integer>

Whether to notify HR before expiry. 1 = yes, 0 = no.

Available options:
0,
1
expiring_inform_hr_period
integer

Days before expiry to notify HR.

expired_inform
enum<integer>

Whether to notify worker on expiry. 1 = yes, 0 = no.

Available options:
0,
1
expired_inform_hr
enum<integer>

Whether to notify HR on expiry. 1 = yes, 0 = no.

Available options:
0,
1
rule_usable
enum<integer>

Whether the credential can be used in matching rules. 1 = yes, 0 = no.

Available options:
0,
1
worker_viewable
enum<integer>

Whether the worker can view this credential. 1 = viewable, 0 = hidden.

Available options:
0,
1
worker_editable
enum<integer>

Whether the worker can edit this credential. 1 = editable, 0 = read-only.

Available options:
0,
1
type
enum<string>

Credential type.

Available options:
General,
Client,
Venue
protected
enum<integer>

Whether the credential is protected from deletion. 1 = protected, 0 = not protected.

Available options:
0,
1
course_id
integer | null

Associated course ID. null if not linked to a course.

expiration_months
integer | null

Number of months until auto-expiry. null if no auto-expiry.