< back to index

HTTP request

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

Required Parameters

Parameter name Value Description
text_from_search_field string The string of text for which we want to search
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),
  "text_from_search_field": string,
  "search_results_found": boolean,
  "search_results": list
   [{
     "result_title": string,
     "result_image": string,
     "result_subtitle": string,
     "result_summary": string,
     "result_score": integer,
     "link_internal": string,
     "kind_of_owner": string,
     "google_civic_election_id": integer,
     "state_code": string,
     "twitter_handle": string,
     "we_vote_id": string,
     "local_id": integer,
   },]
}

Response Status Codes

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

Try It Now: API Variables

Parameter name Value  
text_from_search_field:
voter_device_id:

(opens in new window)