< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/sharedItemRetrieve (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
shared_item_code string The code coming from the URL that we need to look up the final destination.

Optional Parameters

Parameter name Value Description
shared_item_clicked boolean Is this retrieve because of this voter clicking?

Response

{
  "status": string,
  "success": boolean,
  "destination_full_url": string,
  "shared_item_code_no_opinions": string,
  "shared_item_code_all_opinions": string,
  "url_with_shared_item_code_no_opinions": string,
  "url_with_shared_item_code_all_opinions": string,
  "is_ballot_share": boolean,
  "is_candidate_share": boolean,
  "is_measure_share": boolean,
  "is_office_share": boolean,
  "is_ready_share": boolean,
  "google_civic_election_id": integer,
  "site_owner_organization_we_vote_id": string,
  "shared_by_voter_we_vote_id": string,
  "shared_by_organization_type": string,
  "shared_by_organization_we_vote_id": string,
  "candidate_we_vote_id": string,
  "measure_we_vote_id": string,
  "office_we_vote_id": string,
  "date_first_shared": datetime,
}

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

Parameter name Value  
voter_device_id:
shared_item_code:
shared_item_clicked: True
False

(opens in new window)