Participant Object


A participant entity represents a site member who takes part in a specific Online Program. Participants have access to the program's content and progress through the program by completing its steps. A participant can join through a join application flow or be manually added by the program owner. A participant's status depends on their progress and the program's settings (e.g., start and end dates). Participation may also be temporarily suspended.

Properties
certificateInfoCertificateInfoRead-only

Information about the participant's certificate.

Returned only when a certificate has been issued to the participant.


createdDatestringRead-onlyformat date-time

Date and time the participant was created.


enrollmentInfoEnrollmentInfo

Additional information about the participant's enrollment and completion timeframe in the program.


enrollmentStatusstringRead-only

Participant's enrollment status in the program.


extendedFieldsExtendedFields

Custom field data for the participant object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUID

Participant ID.


lastActivityDatestringRead-onlyformat date-time

Last activity date of the participant in the program (can either be status change or step resolution).


memberMemberRead-only

Snapshot of the site member identified by memberId, copied from the Members API. It isn't the authoritative member record.


memberIdstringRead-onlyformat GUID

Member ID of the participant on the site.


programIdstringRead-onlyformat GUID

ID of the program the participant is enrolled in.


progressProgressRead-only

Program completion progress. This field is conditional and must be explicitly requested using the fields parameter.


progressStatusstringRead-only

Participant's progress status in the program.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the participant is updated. To prevent conflicting changes, the current revision must be specified when updating the participant.

Ignored when creating a participant.


tagsTags

Tags for categorizing and organizing participants.


updatedDatestringRead-onlyformat date-time

Date and time the participant was updated.

Did this help?