Earners Lists

The list allows organizations to track badge assignment and the status of badge earners.

An Earner is an individual who has earned badges after fulfilling the necessary criteria.

Received values

Field	Type	Description
id	`string`	Unique identifier.
name	`string`	Name of the list.
description	`string`	Description of the list.
status	`ENUM`	Status of the list. Possible values: `enabled`, `disabled`.
type	`ENUM`	Type of the list. Possible values: `import`: Used when the list is not saved for future use. `list`: Used if the list is saved for future reference.
earners	`array`	Array containing details of earners included in the list.
earners.id	`string`	Unique identifier for each earner.
earners.recipient_email	`string`	Email of the recipient.
earners.recipient_first_name	`string`	First name of the recipient.
earners.recipient_last_name	`string`	Last name of the recipient.
earners.metadata	`json`	JSON object containing metadata values related to each earner, if any.
earners.created_at	`timestamp`	Date and time when the earner was created. Format: `YYYY-MM-DD HH:MM:SS`, UTC timezone.
earners.updated_at	`timestamp`	Date and time when the earner was last updated. Format: `YYYY-MM-DD HH:MM:SS`, UTC timezone.
earners.email_verified_at	`timestamp`	Date and time when the earner's email was verified. Format: `YYYY-MM-DD HH:MM:SS`, UTC timezone.
created_at	`timestamp`	Date and time when the list was created. Format: `YYYY-MM-DD HH:MM:SS`, UTC timezone.
updated_at	`timestamp`	Date and time when the list was last updated. Format: `YYYY-MM-DD HH:MM:SS`, UTC timezone.

Last modified: 12 November 2024