Documentation

List Credential Types

GET /sites/{site_id}/training
GET /portals/{portal_id}/training

Path Parameters

Parameter Type Required Description
site_id string Yes ID of the site (for first endpoint)
portal_id string Yes ID of the portal (for second endpoint)

Query Parameters

Parameter Type Default Description
active boolean Omitted Set true for active types or false for inactive types. Omit for both.
excludes_portal boolean false When requesting site level credential types, types from linked portals where the caller has explicit membership are included unless this is set to true
include_records boolean false Adds training_records when matching records exist. These records come from active types and have expiry dates after today.

Response

data contains an array of credential types. The caller must be a member of the requested site or portal.

See the Credentials API overview for related endpoints and shared data structures.