< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterPlanListRetrieve (Jump to "Try It Now")

Required Parameters

Parameter name	Value	Description
api_key	string (from post, cookie, or get (in that order))	The unique key provided to any organization using the WeVoteServer APIs

Optional Parameters

Parameter name	Value	Description
google_civic_election_id	integer	Limit results to this election

Response

{
  "success": boolean,
  "status": string,
  "voter_plan_list": list
   [{
     "google_civic_election_id": integer,
     "state_code": string,
     "voter_display_name": string,
     "voter_display_city_state": string,
     "voter_we_vote_id": string,
     "voter_plan_data_serialized": string,
     "voter_plan_text": string,
     "show_to_public": boolean,
     "date_entered": string,
     "date_last_changed": string,
     "we_vote_hosted_profile_image_url_medium": string,
   },],
}

Response Status Codes

Code	Description
VALID_VOTER_DEVICE_ID_MISSING	A valid voter_device_id parameter was not included. Cannot proceed.
VOTER_NOT_FOUND_FROM_VOTER_DEVICE_ID	No voter could be found from the voter_device_id

Try It Now: API Variables

Retrieve a voter_plan_list that we can display publicly.

Parameter name	Value
google_civic_election_id:

(opens in new window)