< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/organizationSearch (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
organization_search_term string String of text used in AND search.
organization_name string Name of the organization that is displayed.
organization_email string Contact email of the organization.
organization_website string Website of the organization.
organization_twitter_handle string Twitter handle of the organization.
exact_match boolean Require an exact match (case insensitive) of all fields submitted.

Response

{
  "status": string,
  "success": boolean,
  "voter_device_id": string (88 characters long),
  "organization_search_term": string (the original search term passed in),
  "organization_email": string (the original search term passed in),
  "organization_name": string (the original search term passed in),
  "organization_twitter_handle": string (the original search term passed in),
  "organization_website": string (the original search term passed in),
  "exact_match": boolean (did the search require exact match?),
  "organizations_list": list
   [
     "organization_id": integer,
     "organization_we_vote_id": string,
     "organization_name": string,
     "organization_twitter_handle": string,
     "organization_facebook": string,
     "organization_email": string,
     "organization_website": string,
   ],
}

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.
ORGANIZATION_SEARCH_ALL_TERMS_MISSING Cannot proceed. No search terms were provided.
ORGANIZATIONS_RETRIEVED Successfully returned a list of organizations that match search query.
NO_ORGANIZATIONS_RETRIEVED Successfully searched, but no organizations found that match search query.

Try It Now: API Variables

Find a list of all organizations that match any of the search terms.

Parameter name Value  
voter_device_id:
organization_search_term:
organization_name:
organization_email:
organization_website:
organization_twitter_handle:
exact_match: True
False

(opens in new window)