< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterGuidePossibilityRetrieve (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
voter_guide_possibility_url string The url where a voter guide can be found.

Response

{
  "status": string,
  "success": boolean,
  "voter_device_id": string (88 characters long),
  "voter_guide_possibility_url": string,
  "voter_guide_possibility_id": integer,
  "organization_we_vote_id": string,
  "public_figure_we_vote_id": string,
  "owner_we_vote_id": string,
}

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.
VOTER_GUIDE_POSSIBILITY_NOT_FOUND A voter guide possibility was not found at that URL.
VOTER_GUIDE_POSSIBILITY_FOUND_WITH_URL A voter guide possibility entry was found.

Try It Now: API Variables

Has a particular web page URL been captured as a possible voter guide?

Parameter name Value  
voter_device_id:
voter_guide_possibility_url:

(opens in new window)