Certificates
The logs/story-certificates
endpoint retrieves certificates awarded to users on stories.
Parameters
All parameters are optional and if none are provided all stories, users and groups will be called.
Key | Type |
app | String (ID or name of app) |
story | String (ID or name of stories) |
groups | Array String (name of group) |
users | Array String (name or email) |
Example
The example below fetches user certificates for stories listed in the stories
parameter.
Success Response
A successful response will return an array of story
+ certificates
items.
Story + Certificates item
Key | Type |
story | Object |
story.ID | String |
story.name | String |
story.type | Enum (story, assessment, survey, scorm) |
certificates | Array of certificate items |
Certificate Item
The certificate item will contain user information and a certificate object.
Key | Type |
firstname | String |
lastname | String |
String | |
telephone | String |
country | String |
city | String |
certificate | Object |
certificate.url | String (Permalink of the certificate) |
certificate.state | Enum (pending, delivered) |
certificate.timestamp | String |
Last updated