HTTP request
GET https://api.wevoteusa.org/apis/v1/challengeParticipantListRetrieve (Jump to "Try It Now")
Required Parameters
Parameter name | Value | Description |
voter_device_id | string | An 88 character unique identifier linked to a voter record on the server |
api_key | string (from post, cookie, or get (in that order)) | The unique key provided to any organization using the WeVoteServer APIs |
challenge_we_vote_id | string | The we_vote_id for the challenge. |
Response
{ "status": string, "success": boolean, "challenge_we_vote_id": string, "date_last_changed": string, "participant_list: list [{ "challenge_we_vote_id": string, "date_joined": string, "date_last_changed": string, "invitees_count": number, "invitees_who_joined": number, "invitees_who_viewed": number, "invitees_who_viewed_plus": number, "organization_we_vote_id": string, "participant_name": string, "points": number, "rank": number, "visible_to_public": boolean, "voter_we_vote_id": string, "we_vote_hosted_profile_image_url_medium": string, "we_vote_hosted_profile_image_url_tiny": string, },] }
Response Status Codes
Code | Description |
VALID_VOTER_DEVICE_ID_MISSING | Cannot proceed. A valid voter_device_id parameter was not included. |
VALID_VOTER_ID_MISSING | Cannot proceed. A valid voter_id was not found. |
Try It Now: API Variables