List Credential Records
GET /training/records
Required Query Parameters (One or more required)
| Parameter | Type | Required | Description |
|---|---|---|---|
user_training_record_id |
string | No* | Specific credential record ID. An alias is record_id. |
site_id |
string | No* | Records for users within this site |
portal_id |
string | No* | Records for users within this portal |
training_id |
string | No* | Records for this credential type. |
user_id |
string | No* | Records for a specific user. |
* At least one of these parameters is required.
Optional Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
newest_only |
boolean | false |
Only return the most recent record for each user |
expiring |
boolean | false |
Return records with an expiry from the last week through the next 30 days. |
return_count |
boolean | false |
Set true for the total before pagination. Otherwise numitems counts the returned records. |
limit |
integer | Omitted | Page size. Without a limit, the API applies its maximum result cap. |
offset |
integer | 0 |
Combine with limit to offset the first record in the returned list |
Response
data contains an array of credential records. An ID lookup by user_training_record_id or record_id returns one object. Use site_id or portal_id to scope a list, with at most one of those two scopes.
See the Credentials API overview for related endpoints and shared data structures.