< back to index

HTTP request

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

Required Parameters

Parameter name Value Description
google_civic_election_id_list[] integerlist List of election ids we care about.


  "status": string,
  "success": boolean,
  "google_civic_election_id_list": list,
  "candidate_list": list
     "name": string,
     "we_vote_id": string,
     "alternate_names": list,
     "String here",

Response Status Codes

Code Description
VALID_OFFICE_ID_AND_OFFICE_WE_VOTE_ID_MISSING A valid internal office_id parameter was not included, nor was a office_we_vote_id. Cannot proceed.
CANDIDATES_RETRIEVED Candidates were returned for these elections.
NO_CANDIDATES_RETRIEVED There are no candidates stored for these elections.

Try It Now: API Variables

Retrieve all the candidates competing in upcoming offices. This shares the same response package format with measureListForUpcomingElectionsRetrieve.

Parameter name Value  

(opens in new window)