< back to index
HTTP request
GET https://api.wevoteusa.org/apis/v1/friendList (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 |
| kind_of_list |
string |
Default is CURRENT_FRIENDS. Other options include FRIEND_INVITATIONS_PROCESSED, FRIEND_INVITATIONS_SENT_TO_ME, FRIEND_INVITATIONS_SENT_BY_ME, FRIEND_INVITATIONS_WAITING_FOR_VERIFICATION, FRIENDS_IN_COMMON, IGNORED_FRIEND_INVITATIONS, or SUGGESTED_FRIEND_LIST. |
Optional Parameters
| Parameter name |
Value |
Description |
| state_code |
string |
Only show friends who live in this state. |
Response
{
"status": string,
"success": boolean,
"count": integer,
"voter_we_vote_id": string,
"state_code": string,
"kind_of_list": string,
"friend_list": list
[{
"voter_we_vote_id": string,
"voter_display_name": string,
"voter_photo_url_large": string,
"voter_photo_url_medium": string,
"voter_photo_url_tiny": string,
"voter_email_address": string,
"voter_twitter_handle": string,
"voter_twitter_description": string,
"voter_twitter_followers_count": number,
"linked_organization_we_vote_id": string,
"state_code_for_display": string,
"invitation_status": string,
"invitation_sent_to": string,
"positions_taken": number,
"mutual_friend_count": number,
"mutual_friend_preview_list": list
[{
"friend_display_name": string,
"friend_photo_url_medium": string,
}],
"mutual_friends": number,
}],
}
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
Request information about a voter's friends, including invitations to become a friend, a list of current friends, and friends you share in common with another voter.