< back to index
HTTP request
GET https://api.wevoteusa.org/apis/v1/twitterSignInRetrieve (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 |
| voter_device_id |
string |
An 88 character unique identifier linked to a voter record on the server |
Optional Parameters
| Parameter name |
Value |
Description |
| image_load_deferred |
boolean |
Process new images from twitter asynchronously with twitter_process_deferred_images_for_api. If false process images inline (adds many seconds to sign in with twitter) |
Response
{
"status": string,
"success": boolean,
"twitter_voters_access_token_secret": string,
"twitter_email": string,
"twitter_first_name": string,
"twitter_image_load_info: object,
"twitter_last_name": string,
"twitter_middle_name": string,
"twitter_profile_image_url_https": string,
"twitter_retrieve_attempted": boolean,
"twitter_sign_in_found": boolean,
"twitter_sign_in_verified": boolean,
"twitter_signed_request": string,
"twitter_user_id": string,
"voter_device_id": string (88 characters long),
"voter_we_vote_id_attached_to_twitter": string,
"voter_we_vote_id_attached_to_twitter_email": string,
"we_vote_hosted_profile_image_url_large": string,
"we_vote_hosted_profile_image_url_medium": string,
"we_vote_hosted_profile_image_url_tny": string,
}
Response Status Codes
| Code |
Description |
| VALID_VOTER_DEVICE_ID_MISSING |
Cannot proceed. A valid voter_device_id parameter was not included. |
| MISSING_VOTER_ID_OR_ADDRESS_TYPE |
Cannot proceed. Missing variables voter_id or address_type while trying to save. |
Try It Now: API Variables
Retrieve the Twitter Sign In status based on voter_device_id.