{"info":{"_postman_id":"d4b62955-d021-4538-b79a-937c4e302b96","name":"[DEPRECATED] Pointerpro API","description":"

Welcome to the Pointerpro API reference!

\n

Check out https://pointerpro.com/ for more info on our products

\n

General

\n

The main api url is https://api.pointerpro.com/v1

\n

Two headers are required with each request:

\n
    \n
  1. Add Authorization header with your API key as value. You can create and find your API key under My Account
    2. \n
  2. Send the Content-Type header with value application/json
    3. \n
\n

Usage

\n

There is a maximum of 60 API requests per minute per API Key.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"General","slug":"general"},{"content":"Usage","slug":"usage"}],"owner":"2178574","collectionId":"d4b62955-d021-4538-b79a-937c4e302b96","publishedId":"S11KRK2H","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-08-30T07:49:21.000Z"},"item":[{"name":"Access Codes","item":[{"name":"Create access codes","id":"b53bed87-c4bd-4821-aeb5-a2ead33282ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"codes\": [\n \t\"code1\",\n \t\"code2\"\n\t]\n}"},"url":"https://api.pointerpro.com/v1/surveys/{surveyUID}/accesscodes","description":"

Create access codes

\n","urlObject":{"protocol":"https","path":["v1","surveys","{surveyUID}","accesscodes"],"host":["api","pointerpro","com"],"query":[],"variable":[]}},"response":[{"id":"4ab9adb9-8d0e-435a-8b14-22cc1fee5b21","name":"Create access codes","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"codes\": [\n \t\"code1\",\n \t\"code2\"\n\t]\n}"},"url":"https://api.pointerpro.com/v1/surveys/{surveyUID}/accesscodes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Mar 2019 10:23:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Request-Headers","value":"SA-TOKEN, Authorization"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, cache-control, SA-TOKEN, Pragma, X-Requested-With, If-Modified-Since, Accept-Encoding, DNT, Accept-Language, Authorization"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2\n}"}],"_postman_id":"b53bed87-c4bd-4821-aeb5-a2ead33282ab"}],"id":"68951118-ed3e-48a3-bf66-f7317cc315ba","event":[{"listen":"prerequest","script":{"id":"eb2749d5-b325-4781-9307-1ef8f0ffc896","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"66e67990-2db6-422d-bd85-9c07403fbb8e","type":"text/javascript","exec":[""]}}],"_postman_id":"68951118-ed3e-48a3-bf66-f7317cc315ba","description":""},{"name":"Contacts","item":[{"name":"Create contact","id":"97aafa3a-a67d-40ed-bdc5-17c3182de210","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"external_id\": \"321\",\n \"group_id\": null,\n \"parent_email\": \"hello@test.com (optional)\",\n \"custom_data\": \"lorem ipsum (optional)\"\n}"},"url":"https://api.pointerpro.com/v1/respondents","description":"

Creates a single contact object

\n","urlObject":{"protocol":"https","path":["v1","respondents"],"host":["api","pointerpro","com"],"query":[],"variable":[]}},"response":[{"id":"22f396d0-b5b9-4826-bc98-8e6cc95db764","name":"Create contact","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"external_id\": \"321\",\n \"custom_data\": \"lorem ipsum\",\n \"group_id\": null\n}","options":{"raw":{"language":"json"}}},"url":"api.pointerpro.com/v1/respondents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Mar 2019 10:23:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Request-Headers","value":"SA-TOKEN, Authorization"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, cache-control, SA-TOKEN, Pragma, X-Requested-With, If-Modified-Since, Accept-Encoding, DNT, Accept-Language, Authorization"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1547269,\n \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"external_id\": \"321\",\n \"unique_identifier\": \"yZOhI0dKT\",\n \"custom_data\": \"lorem ipsum\",\n \"do_not_mail\": false,\n \"user_id\": 199\n}"}],"_postman_id":"97aafa3a-a67d-40ed-bdc5-17c3182de210"}],"id":"cb1a055b-9ee8-4a3f-a1f7-95dc1b88b88b","description":"

Requests to manage contact objects

\n

See following link for more information on the concept of contacts https://help.pointerpro.com/en/support/solutions/articles/35000039237-my-contacts

\n","_postman_id":"cb1a055b-9ee8-4a3f-a1f7-95dc1b88b88b"},{"name":"Email invitations","item":[{"name":"Trigger email invitation","id":"6b918504-b50a-40a4-80cf-37bf713d0e2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"respondents\": [\n {\n\t\t\t\"email\": \"john.doe@acme.com\",\n\t\t\t\"external_id\": \"1234\",\n\t\t\t\"last_name\": \"doe\",\n\t\t\t\"name\": \"John\",\n\t\t\t\"groups\": \"list1|list2\"\n\t\t}\n\t]\n}"},"url":"https://api.pointerpro.com/v1/emails/trigger/{id}","urlObject":{"protocol":"https","path":["v1","emails","trigger","{id}"],"host":["api","pointerpro","com"],"query":[],"variable":[]}},"response":[{"id":"84921c0b-96bf-4631-a709-66fd26e6631d","name":"Trigger email invitation (error)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"respondents\": [\n {\n\t\t\t\"email\": \"john.doe@acme\",\n\t\t\t\"external_id\": \"1234\",\n\t\t\t\"last_name\": \"doe\",\n\t\t\t\"name\": \"John\",\n\t\t\t\"groups\": \"list1|list2\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.pointerpro.com/v1/emails/trigger/{id}"},"code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"The import failed because the email address john.doe@acme is invalid.\",\n \"code\": 400,\n \"key\": \"invalid_email\"\n}"},{"id":"ecac9a42-559f-4eb8-9354-018482e91096","name":"Trigger email invitation (success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"respondents\": [\n {\n\t\t\t\"email\": \"john.doe@acme.com\",\n\t\t\t\"external_id\": \"1234\",\n\t\t\t\"last_name\": \"Doe\",\n\t\t\t\"name\": \"John\",\n\t\t\t\"groups\": \"list1|list2\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.pointerpro.com/v1/emails/trigger/{id}"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"triggered\": true\n}"}],"_postman_id":"6b918504-b50a-40a4-80cf-37bf713d0e2b"}],"id":"31fcaf0b-d519-454f-80e2-0266b244108d","_postman_id":"31fcaf0b-d519-454f-80e2-0266b244108d","description":""},{"name":"Surveys","item":[{"name":"Copy survey","id":"e4f93af8-35d4-449d-9295-5daf7baae07b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"survey_url\": \"url_to_copy\"\n}"},"url":"https://api.pointerpro.com/v1/surveys","description":"

Copy an existing survey by URL

\n","urlObject":{"protocol":"https","path":["v1","surveys"],"host":["api","pointerpro","com"],"query":[],"variable":[]}},"response":[{"id":"67b7842b-4236-4527-87d5-48ad023f08df","name":"Copy survey (success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"survey_url\": \"exampleUrl123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.pointerpro.com/v1/surveys"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"surveyId\": 123,\n \"url\": \"newURL\",\n \"title\": \"The survey (Copy)\",\n \"unique_identifier\": \"541e13e5-28c4-496a-b1a1-89ecc7c62c5a\"\n}"},{"id":"da9405fa-6416-4323-af0a-b3e121b16788","name":"Copy survey (error)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API "},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"survey_url\": \"exampleUrl123\"\n}","options":{"raw":{"language":"json"}}},"url":"api.pointerpro.com/v1/surveys"},"code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Mar 2019 10:23:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Request-Headers","value":"SA-TOKEN, Authorization"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, cache-control, SA-TOKEN, Pragma, X-Requested-With, If-Modified-Since, Accept-Encoding, DNT, Accept-Language, Authorization"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"There is no Survey defined with that ID\",\n \"code\": 404,\n \"key\": \"resource_not_found\"\n}"}],"_postman_id":"e4f93af8-35d4-449d-9295-5daf7baae07b"}],"id":"796a2663-e230-4217-bc2b-5af0f22fda06","_postman_id":"796a2663-e230-4217-bc2b-5af0f22fda06","description":""}],"event":[{"listen":"prerequest","script":{"id":"667c37c8-d5ca-40d3-a70f-3111330fa592","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"29b849b5-b222-4ec2-8ca7-6f3557a9473c","type":"text/javascript","exec":[""]}}]}