< back to index

HTTP request

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

Optional Parameters

Parameter name Value Description
organization_we_vote_id string Retrieve all voter guides for this organization.
voter_we_vote_id string Retrieve all voter guides for this voter.
maximum_number_to_retrieve integer Defaults to 20 voter guides. Enter a value to set your own limit.

Response

{
  "status": string,
  "success": boolean,
  "voter_guides": list
   [
     "election_day_text": string (YYYY-MM-DD),
     "google_civic_election_id": integer,
     "organization_we_vote_id": string (We Vote ID for the org that owns the voter guide),
     "last_updated": string (time in this format %Y-%m-%d %H:%M),
     "pledge_goal": integer,
     "pledge_count": integer,
     "state_code": string,
     "twitter_description": string,
     "twitter_followers_count": integer,
     "twitter_handle": integer,
     "voter_guide_display_name": string (Name of this org or person),
     "voter_guide_image_url_large": string, 
     "voter_guide_image_url_medium": string, 
     "voter_guide_image_url_tiny": string, 
     "voter_guide_owner_type": ORGANIZATION, PUBLIC_FIGURE, VOTER),
     "we_vote_id": string (We Vote ID of the voter guide),
   ],
  "maximum_number_to_retrieve": integer,
}

Try It Now: API Variables

Parameter name Value  
organization_we_vote_id:
voter_we_vote_id:
maximum_number_to_retrieve:

(opens in new window)