HTTP request
GET https://api.wevoteusa.org/apis/v1/challengeRetrieve (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 unique id of the challenge. If this value is "", then the API will attempt to do the lookup by seo_friendly_path if one is supplied. |
| seo_friendly_path | string | The SEO friendly path component. |
Response
{
"status": string,
"success": boolean,
"challenge_description": string,
"challenge_invite_text_default": string,
"challenge_title": string,
"challenge_politician_list_exists": boolean,
"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,
"organization_we_vote_id": string,
"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_news_item_list": list
[
{
"challenge_news_subject": string,
"challenge_news_text": string,
"challenge_news_item_we_vote_id": string,
"challenge_we_vote_id": string,
"date_last_changed": string,
"date_posted": string,
"date_sent_to_email": string,
"in_draft_mode": string,
"organization_we_vote_id": string,
"speaker_name": string,
"visible_to_public": boolean,
"voter_we_vote_id": string,
"we_vote_hosted_profile_image_url_tiny": string,
},
],
"challenge_owner_list": list
[
{
"feature_this_profile_image": boolean,
"organization_name": string,
"organization_we_vote_id": string,
"visible_to_public": boolean,
"we_vote_hosted_profile_image_url_medium": string,
"we_vote_hosted_profile_image_url_tiny": string,
},
],
"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_starter_list": list
[
{
"value": string,
"label": string,
},
],
"latest_challenge_participant_list": list
[
{
"id": integer,
"challenge_we_vote_id": string,
"date_joined": string,
"organization_we_vote_id": string,
"supporter_endorsement": string,
"participant_name": string,
"voter_we_vote_id": string,
"we_vote_hosted_profile_image_url_medium": string,
"we_vote_hosted_profile_image_url_tiny": string,
},
],
"seo_friendly_path_list": list
[],
"voter_challenge_participant": {
"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,
},
}
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