< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterContactListRetrieve (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

Optional Parameters

Parameter name Value Description
google_civic_election_id integer Limit results to this election


  "success": boolean,
  "status": string,
  "voter_contact_email_list": list
     "date_last_changed": string,
     "email_address_text": string,
     "google_contact_id": string,
     "google_date_last_updated": string,
     "google_display_name": string,
     "google_first_name": string,
     "google_last_name": string,
     "has_data_from_google_people_api": boolean,
     "ignore_contact": boolean,
     "imported_by_voter_we_vote_id": string,
     "is_friend": boolean,
     "state_code": 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_contact_list that we can display publicly.

Parameter name Value  

(opens in new window)