< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/campaignRetrieve (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
campaignx_we_vote_id string The unique id of the campaign.

Response

{
  "status": string,
  "success": boolean,
  "campaign_title": string,
  "in_draft_mode": boolean,
  "campaignx_we_vote_id": string,
  "organization_we_vote_id": string,
  "voter_we_vote_id": 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.

Try It Now: API Variables

Parameter name Value  
voter_device_id:
campaignx_we_vote_id:

(opens in new window)