HTTP request
GET https://api.wevoteusa.org/apis/v1/challengeListRetrieve (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 |
Response
{ "status": string, "success": boolean, "challenge_list": list [ "challenge_description": string, "challenge_invite_text_default": string, "challenge_title": string, "challenge_we_vote_id": string, "final_election_date_as_integer": integer, "final_election_date_in_past": boolean, "in_draft_mode": boolean, "is_blocked_by_we_vote": boolean, "is_blocked_by_we_vote_reason": string, "is_supporters_count_minimum_exceeded": boolean, "opposers_count": integer, "seo_friendly_path": string, "supporters_count": integer, "supporters_count_next_goal": integer, "supporters_count_victory_goal": integer, "visible_on_this_site": boolean, "voter_can_send_updates_to_challenge": boolean, "voter_is_challenge_owner": boolean, "voter_signed_in_with_email": boolean, "voter_we_vote_id": string, "we_vote_hosted_challenge_photo_large_url": string, "we_vote_hosted_challenge_photo_medium_url": string, "we_vote_hosted_challenge_photo_small_url": string, "challenge_owner_list": list [ "feature_this_profile_image": boolean, "organization_name": string, "organization_we_vote_id": string, "we_vote_hosted_profile_image_url_medium": string, "we_vote_hosted_profile_image_url_tiny": string, "visible_to_public": boolean, ], "challenge_politician_list": list [ "challenge_politician_id": integer, "politician_name": string, "politician_we_vote_id": string, "state_code": string, "we_vote_hosted_profile_image_url_large": string, "we_vote_hosted_profile_image_url_medium": string, "we_vote_hosted_profile_image_url_tiny": string, ], "challenge_politician_list_exists": boolean, "challenge_politician_starter_list": list [ "value": string, "label": string, ], "seo_friendly_path_list": list [], ], "challenge_list_found": boolean, "promoted_challenge_list_returned": boolean, "promoted_challenge_we_vote_ids": list [], "voter_challenge_participant": { "id": integer, "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, "invite_text_for_friends": string, "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, }, "voter_can_send_updates_challenge_we_vote_ids": list [], "voter_can_vote_for_politicians_list_returned": boolean, "voter_can_vote_for_politician_we_vote_ids": list [], "voter_owned_challenge_list_returned": boolean, "voter_owned_challenge_we_vote_ids": list [], "voter_started_challenge_list_returned": boolean, "voter_started_challenge_we_vote_ids": list [], "challenge_we_vote_ids_where_voter_is_participant_returned": boolean, "challenge_we_vote_ids_where_voter_is_participant": list [], }
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