voterGuidesFollowedByOrganizationRetrieve
< back to index
HTTP request
GET https://api.wevoteusa.org/apis/v1/voterGuidesFollowedByOrganizationRetrieve (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 |
| filter_by_this_google_civic_election_id |
integer |
Limit the list of voter guides that the org is following to only those for this election. |
| maximum_number_to_retrieve |
integer |
Defaults to 20 voter guides. Enter a value to set your own limit. |
Response
{
"status": string,
"success": boolean,
"voter_device_id": string (88 characters long),
"voter_guides": list
[
"voter_guide_display_name": string (Name of this org or person),
"voter_guide_owner_type": ORGANIZATION, PUBLIC_FIGURE, VOTER),
"we_vote_id": string (We Vote ID of the voter guide),
"organization_we_vote_id": string (We Vote ID for the org that owns the voter guide),
"public_figure_we_vote_id": string (We Vote ID for the person that owns the voter guide),
"voter_guide_image_url_large": string (We Vote ID for the person that owns the voter guide),
"voter_guide_image_url_medium": string (We Vote ID for the person that owns the voter guide),
"voter_guide_image_url_tiny": string (We Vote ID for the person that owns the voter guide),
"last_updated": string (time in this format %Y-%m-%d %H:%M:%S),
"google_civic_election_id": integer,
"twitter_description": string,
"twitter_followers_count": integer,
"twitter_handle": integer,
"owner_voter_id": integer TO BE DEPRECATED,
],
"google_civic_election_id": integer,
"maximum_number_to_retrieve": 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