{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a61dbf9f-719a-4517-af33-9189e23e5328","name":"CiviClick 2.0 API","description":"Welcome to the API documentation for CiviClick 2.0! The API enables you to access and manage your CiviClick data programmatically.\n\nYou can see that the different endpoint groups encapsulate operations related to key entities: **Campaigns**, **Actions** and **Advocates**. You can browse the related endpoints and functionalities below, under the heading of each entity.\n\nValues to be replaced are indicated in double curly brackets like this: `{{API_key}}`. Replace the actual value without including the curly brackets, so for example if your API key is 1234, \"Bearer `{{API_key}}`\" would resolve to \"Bearer 1234\".\n\n# A**uthentication and API usage**\n\n- You must use a valid API Key to send requests to the API endpoints. You can get your API key from the [Admin tab](https://d194.bubble.is/site/newciviclick/version-live/campaign?tab=Admin&view=Promoters) in the app under the `API access` section.\n    \n- The API Key should be included in the `Authorization` header in the format  \n    \"Bearer `{{your_API_key}}\"`\n    \n- If the API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n    \n- The API has no explicit rate or usage limitation; we trust our Customers to use the API responsibly. In case we notice a sudden spike in the volume or frequency of your API calls, our **Customer Success Team** will reach out to you.\n    \n- An HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, please contact our Customer Success Team via email or the Get Help button in the app.\n    \n- The API only responds to HTTPS-secured communications.\n    \n- The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"41585426","team":6723772,"collectionId":"a61dbf9f-719a-4517-af33-9189e23e5328","publishedId":"2sB2ixkuDg","public":true,"publicUrl":"https://docs.civiclick.com","privateUrl":"https://go.postman.co/documentation/41585426-a61dbf9f-719a-4517-af33-9189e23e5328","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"d7253d"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"This API docs site explains how CiviClick's customers can utilize the 2.0 API endpoints to access and manage their campaigns, advocates or campaign submissions."},{"name":"title","value":"CiviClick 2.0 API documentation"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/0959a0fe-b3cc-4378-8fe3-4c0edae2136b/Q2l2aUNsaWNrIExvZ29fV2hpdGUucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"d7253d"}},{"name":"light","logo":"https://content.pstmn.io/0959a0fe-b3cc-4378-8fe3-4c0edae2136b/Q2l2aUNsaWNrIExvZ29fV2hpdGUucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"d7253d"}}]}},"version":"8.10.1","publishDate":"2025-04-25T07:58:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"CiviClick 2.0 API documentation","description":"This API docs site explains how CiviClick's customers can utilize the 2.0 API endpoints to access and manage their campaigns, advocates or campaign submissions."},"logos":{"logoLight":"https://content.pstmn.io/0959a0fe-b3cc-4378-8fe3-4c0edae2136b/Q2l2aUNsaWNrIExvZ29fV2hpdGUucG5n","logoDark":"https://content.pstmn.io/0959a0fe-b3cc-4378-8fe3-4c0edae2136b/Q2l2aUNsaWNrIExvZ29fV2hpdGUucG5n"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d38616caa5f24316a063fe9a62396e6aa6f73fc945b9f56ac093916d11da964d","favicon":"https://civiclick.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.civiclick.com/view/metadata/2sB2ixkuDg"}