< 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

Optional Parameters

Parameter name	Value	Description
url_to_scan	string	The url where a voter guide can be found. Either this url or the voter_guide_possibility_id is required.
voter_guide_possibility_id	integer	Either this id or a url_to_scan is required.
limit_to_this_year	boolean	Limit results to possibilities created this year, defaults to True

Response

{
  "status": string,
  "success": boolean,
  "candidate": dict
   {
     "candidate_we_vote_id": string,
     "candidate_name": string,
     "candidate_website": string,
     "candidate_twitter_handle": string,
     "candidate_email": string,
     "candidate_facebook": string,
     "we_vote_hosted_profile_image_url_medium": string,
     "we_vote_hosted_profile_image_url_tiny": string,
   },
  "candidates_missing_from_we_vote": boolean,
  "cannot_find_endorsements": boolean,
  "capture_detailed_comments": boolean,
  "contributor_comments": string,
  "contributor_email": string,
  "hide_from_active_review": boolean,
  "ignore_this_source": boolean,
  "internal_notes": string,
  "organization": dict
   {
     "organization_we_vote_id": string,
     "organization_name": string,
     "organization_website": string,
     "organization_twitter_handle": string,
     "organization_email": string,
     "organization_facebook": string,
     "we_vote_hosted_profile_image_url_medium": string,
     "we_vote_hosted_profile_image_url_tiny": string,
   },
  "possible_candidate_name": string,
  "possible_candidate_twitter_handle": string,
  "possible_owner_of_website_candidates_list": list,
   [
     {
       "candidate_we_vote_id": string,
       "candidate_name": string,
       "candidate_website": string,
       "candidate_twitter_handle": string,
       "candidate_email": string,
       "candidate_facebook": string,
       "candidate_photo_url_medium": string,
       "candidate_photo_url_tiny": string,
     },
   ]
  "possible_organization_name": string,
  "possible_organization_twitter_handle": string,
  "possible_owner_of_website_organizations_list": list,
   [
     {
       "organization_id": integer,
       "organization_we_vote_id": string,
       "organization_name": string,
       "organization_website": string,
       "organization_twitter_handle": string,
       "organization_email": string,
       "organization_facebook": string,
       "organization_photo_url_medium": string,
       "organization_photo_url_tiny": string,
     },
   ]
  "limit_to_this_state_code": string,
  "url_to_scan": string,
  "voter_device_id": string (88 characters long),
  "voter_guide_possibility_edit": string,
  "voter_guide_possibility_id": integer,
  "voter_guide_possibility_type": 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:
url_to_scan:
voter_guide_possibility_id:
limit_to_this_year:	True False

(opens in new window)