< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/campaignRetrieve (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
campaignx_we_vote_id string The unique id of the campaign. 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,
  "campaign_description": string,
  "campaign_title": string,
  "campaignx_politician_list_exists": boolean,
  "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,
  "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_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_news_item_list": list
   [
   {
     "campaign_news_subject": string,
     "campaign_news_text": string,
     "campaignx_news_item_we_vote_id": string,
     "campaignx_we_vote_id": string,
     "date_last_changed": string,
     "date_posted": 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,
   },
   ],
  "campaignx_owner_list": list
   [
   {
     "organization_name": string,
     "organization_we_vote_id": 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_starter_list": list
   [
   {
     "value": string,
     "label": string,
   },
   ],
  "latest_campaignx_supporter_endorsement_list": list
   [
   {
     "id": integer,
     "campaign_supported": boolean,
     "campaignx_we_vote_id": string,
     "date_supported": string,
     "organization_we_vote_id": string,
     "supporter_endorsement": string,
     "supporter_name": string,
     "voter_we_vote_id": string,
     "we_vote_hosted_profile_image_url_tiny": string,
   },
   ],
  "latest_campaignx_supporter_list": list
   [
   {
     "id": integer,
     "campaign_supported": boolean,
     "campaignx_we_vote_id": string,
     "date_supported": string,
     "organization_we_vote_id": string,
     "supporter_endorsement": string,
     "supporter_name": string,
     "voter_we_vote_id": string,
     "we_vote_hosted_profile_image_url_tiny": string,
   },
   ],
  "seo_friendly_path_list": 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

Parameter name Value  
voter_device_id:
campaignx_we_vote_id:
seo_friendly_path:

(opens in new window)