< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterBallotListRetrieve (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,
  "voter_device_id": string (88 characters long),
  "voter_ballot_list": list
   [
     "ballot_returned_we_vote_id": string,
     "ballot_location_shortcut": string,
     "election_description_text": string,
     "election_day_text": string,
     "google_civic_election_id": integer,
     "original_text_for_map_search": string,
     "state_code_list": list
      [],
   ],
}

Response Status Codes

Code Description
VALID_VOTER_DEVICE_ID_MISSING A valid voter_device_id parameter was not included. Cannot proceed.
VALID_VOTER_ID_MISSING A valid voter_id was not found from voter_device_id. Cannot proceed.

Try It Now: API Variables

Retrieve a list of ballots per voter_id

Parameter name Value  
voter_device_id:

(opens in new window)