< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterListAnalytics (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
show_signed_in_voters boolean Only show voters who have signed in. (Default is False)
show_we_vote_id_only boolean Return only a list of We Vote Ids (Default is False)
voter_count_requested integer The number to return. (Default is 10,000 voters)
voter_index_start integer Return the list starting with this voter number.


  "status": string,
  "success": boolean,
  "documentation_url": "https://api.wevoteusa.org/apis/v1/docs/voterListAnalytics/",
  "show_signed_in_voters": boolean (Was there request for only signed in voters?),
  "voter_count_total": integer (the total number of voters to be returned by search parameters),
  "voter_count_requested": integer (ex/ Send me 10,000),
  "voter_count_returned": integer (ex/ 5234),
  "voter_index_start": integer (ex/ returning voter 100),
  "voter_index_end": integer (ex/ ...through voter 200),
  "voter_list": list
     "we_vote_id": string,

Try It Now: API Variables

For accounts that have the right permissions, return a list of voters who have used We Vote.

Parameter name Value  
show_signed_in_voters: True
show_we_vote_id_only: True

(opens in new window)