< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/friendListsAll (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
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,
  "current_friends": list
  "invitations_processed": list
  "invitations_sent_to_me": list
  "invitations_sent_by_me": list
  "invitations_waiting_for_verify": list
  "suggested_friends": list
}

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. This API differs from friendList in that it returns six different lists at once.

Parameter name Value  
voter_device_id:
state_code:

(opens in new window)