< back to index

HTTP request

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

Response

{
  "status": string,
  "success": boolean,
  "highlight_list": list [
    {
      "name": string,
      "we_vote_id": string,
      "prior": integer, ('1' if from a prior election)
    }
  ],
  "never_highlight_on": list [
     "*.wevote.us",
     "api.wevoteusa.org",
     "localhost"
  ]
}

Try It Now: API Variables

Retrieve all of the candidates that might be highlighted on an endorsement guide.

Parameter name Value  

(opens in new window)