Badge templates

id

string

Unique identifier for the badge template.

organization

object

See details of the object returned in Organization

organization_id

string

Identifier for the organization creating the badge.

title

string

Title of the badge.

code

string

Code representing the badge.

type

ENUM

Type of the badge

Possible values: skills, participation, knowledge, qualification.

type_data

object

Characteristics of the specific badge type selected. Related sub type_data values are indicated in the table below.

type_data.acquired_knowledge

string

Knowledge gained by earning the badge.

Required for a Badge type skills, knowledge, qualification.

type_data.acquired_skills

string

Skills gained by earning the badge.

Required for a Badge type skills, knowledge, qualification.

type_data.acquired_attitudes

string

Attitudes or values represented by the badge.

Required for a Badge type knowledge, qualification.

type_data.application_scope

string

Scope of the badge.

Required for a Badge type qualification.

assignment_criteria

string

Criteria required to earn the badge.

image_path

string

URL to the main badge image.

image_high_path

string

URL to the high-resolution badge image.

image_thumbnail_path

string

URL to the thumbnail image of the badge.

background_image_path

string

URL to the background image.

background_image_high_path

string

URL to the high-resolution background image.

background_image_thumbnail_path

string

URL to the thumbnail of the background image.

color_primary

string

Primary color for the badge in HEX format.

description

string

Description of the badge.

other_org

string

Other organization information .

other_org_info

string

Additional information about the other issuance.

language

ENUM

Language code for the badge.

Possible values: en, it.

is_learning_path

boolean

Flag indicating if the badge is part of a learning path

Possible values: 0 or 1.

version_code

integer

Version code of the badge template.

status

string

Status of the badge template

Possible values:

draft, active, archived).

is_published

boolean

Flag indicating if the badge is published on the org public page

Possible values:

0 for unpublished, 1 for published.

badge_template_version_id

string

Version ID of the badge template.

created_at

timestamp

Date and time when the badge template was created

Format returned is YYYY-MM-DD HH:MM:SS, UTC timezone

updated_at

timestamp

Date and time when the badge template was created

Format returned is YYYY-MM-DD HH:MM:SS, UTC timezone