HTTP request
GET https://api.wevoteusa.org/apis/v1/campaignListRetrieve (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,
"campaignx_list": list
[
"campaign_description": string,
"campaign_title": string,
"campaignx_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,
"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_campaignx": boolean,
"voter_is_campaignx_owner": boolean,
"voter_signed_in_with_email": boolean,
"voter_we_vote_id": string,
"we_vote_hosted_campaign_photo_large_url": string,
"we_vote_hosted_campaign_photo_medium_url": string,
"we_vote_hosted_campaign_photo_small_url": string,
"campaignx_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,
],
"campaignx_politician_list": list
[
"campaignx_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,
],
"campaignx_politician_list_exists": boolean,
"campaignx_politician_starter_list": list
[
"value": string,
"label": string,
],
"seo_friendly_path_list": list
[],
],
"campaign_list_found": boolean,
"promoted_campaignx_list_returned": boolean,
"promoted_campaignx_we_vote_ids": list [],
"voter_campaignx_supporter": {
"id": integer,
"campaign_supported": boolean,
"campaignx_we_vote_id": string,
"chip_in_total": string,
"date_last_changed": string,
"date_supported": string,
"organization_we_vote_id": string,
"supporter_endorsement": string,
"supporter_name": string,
"visible_to_public": boolean,
"voter_signed_in_with_email": boolean,
"voter_we_vote_id": string,
"we_vote_hosted_profile_image_url_tiny": string,
},
"voter_can_send_updates_campaignx_we_vote_ids": list [],
"voter_can_vote_for_politicians_list_returned": boolean,
"voter_can_vote_for_politician_we_vote_ids": list [],
"voter_owned_campaignx_list_returned": boolean,
"voter_owned_campaignx_we_vote_ids": list [],
"voter_started_campaignx_list_returned": boolean,
"voter_started_campaignx_we_vote_ids": list [],
"voter_supported_campaignx_list_returned": boolean,
"voter_supported_campaignx_we_vote_ids": 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