Skip to main content
GET
Get participant

Authorizations

Authorization
string
header
required

Personal API token — find yours under My Account → API.

Path Parameters

poll_id
string
required

Poll member_hash or admin_hash

id
string
required

Voter public_id

Query Parameters

organization_id
string

public_id of an organization the user belongs to. When given, the request runs in that organization context instead of the personal account.

Response

participant found

A participant of the poll. Which fields are returned depends on the poll type and on your access level: complete only for surveys, required_option_votes_complete only when the poll requires a vote on all options, and the moderation fields only with admin access.

id
string
required

Voter public_id

user_name
string | null

Name of the participant. A generated name when the poll has anonymize_voter_names.

changed_by_admin
boolean | null

The votes of this participant were changed by an admin.

complete
boolean | null

Surveys only: the participant finished the survey.

created_at
string<date-time> | null
updated_at
string<date-time> | null
fraudulent
boolean | null

Admin access only

paid
boolean | null

Admin access only. false while a voting fee for this participant is still open.

required_option_votes_complete
boolean | null

Admin access only, and only when the poll has option_vote_requirement all_options.

privacy_policy_accepted
boolean | null

Admin access only, and only when the poll has privacy_policy_for_voters.

terms_accepted
boolean | null

Admin access only, and only when the poll has terms_for_voters.