HTTP request
GET https://api.wevoteusa.org/apis/v1/organizationRetrieve (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 |
| organization_id | integer | Internal database unique identifier (one identifier required, either organization_id or organization_we_vote_id) |
| organization_we_vote_id | string | We Vote unique identifier so we can move endorsers from server-to-server (one identifier required, either id or we_vote_id) |
Response
{
"success": boolean,
"status": string,
"facebook_id": integer,
"organization_banner_url": string,
"organization_description": string,
"organization_email": string,
"organization_facebook": string,
"organization_id": integer (the id of the organization found),
"organization_instagram_handle": string,
"organization_name": string (value from Google),
"organization_photo_url_large": string,
"organization_photo_url_medium": string,
"organization_photo_url_tiny": string,
"organization_type": string,
"organization_twitter_handle": string (twitter address),
"organization_we_vote_id": string (the organization identifier that moves server-to-server),
"organization_website": string (website address),
"twitter_description": string,
"twitter_followers_count": integer,
}
Response Status Codes
| Code | Description |
| ORGANIZATION_FOUND_WITH_ID | The organization was found using the internal id |
| ORGANIZATION_FOUND_WITH_WE_VOTE_ID | The organization was found using the we_vote_id |
| ORGANIZATION_RETRIEVE_BOTH_IDS_MISSING | One identifier required. Neither provided. |
| ORGANIZATION_NOT_FOUND_WITH_ID | The organization was not found with internal id. |
| ERROR_<specifics here> | An internal description of what error prevented the retrieve of the organization. |
Try It Now: API Variables
Retrieve the organization using organization_id (first choice) or we_vote_id.