Badges
Represents the actual badge awarded to an Earner once they have completed all requirements and criteria. It is derived from the Badge Template and personalized upon assignment to a specific earner.
Recieved values
Field | Type | Description |
|---|---|---|
id |
| Unique identifier of the badge. |
imported |
| Indicates if the badge was issued by the org or imported from external system. Accepted values: |
status |
| Current status of the badge. Possible values: |
image_path |
| URL of the badge image. |
image_high_path |
| URL of the high-resolution version of the badge image. |
image_thumbnail_path |
| URL of the thumbnail version of the badge image. |
badge_template_version |
| Details of the badge template version, see more in Badge templates. |
organization_id |
| Identifier of the organization issuing the badge. |
activity_title |
| Title of the activity for which the badge is awarded. |
activity_started_at |
| Format returned is YYYY-MM-DD HH:MM:SS, timezone is set as per issuer's input. |
activity_ended_at |
| Format returned is YYYY-MM-DD HH:MM:SS, timezone is set as per issuer's input. |
recipient_email |
| Email address of the badge recipient. |
recipient_first_name |
| First name of the badge recipient. |
recipient_last_name |
| Last name of the badge recipient. |
notes |
| Additional notes or remarks related to the badge. |
additional_details |
| Additional details about the badge, if any. |
url |
| URL to the public view of the badge. |
emitted_at |
| Date and time when the badge was issued. |
expires_at |
| Expiration date and time of the badge, if applicable. Format returned is YYYY-MM-DD HH:MM:SS, timezone is set as per issuer's input. |
created_at |
| Date and time when the badge record was created. Format returned is YYYY-MM-DD HH:MM:SS, UTC timezone |
updated_at |
| Date and time when the badge record was last updated. Format returned is YYYY-MM-DD HH:MM:SS, timezone is set as per issuer's input. |
revoked_at |
| Date and time when the badge was revoked, if applicable. Format returned is YYYY-MM-DD HH:MM:SS, UTC timezone |
revoked_reason |
| Reason for revocation, if the badge was revoked. |
imp_legacy_id |
| Legacy identifier for the badge, if applicable. |
Badge Assignation
The action links an Earner to a badge template and includes metadata about the specific issuance.
Badge assignment flow