{"info":{"_postman_id":"c01b0216-f01f-4b81-8db5-e4cd6958e14e","name":"Simplesat API (v0)","description":"\n

If you have any questions or see any issues, please reach out to us at support@simplesat.io.

\n

Authentication

\n

You need a Simplesat account with an API key to make requests. To find your key, log into your Simplesat account and head over to Admin > Account Settings.

\n

To authenticate, use the API key in a X-Simplesat-Token header.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyValue
X-Simplesat-TokenYour access token
\n

Pagination

\n

By default, most list endpoints return a maximum of 100 records per page. You can change the number of records on a per-request basis by passing a page_size parameter in the request URL parameters. Example: page_size=50.

\n

When the response exceeds the per-page maximum, you can paginate through the records by incrementing the page parameter. Example: page=3. List results include next and previous URLs in the response body for easier navigation:

\n
{\n    \"answers\" [...],\n    \"count\": 106,\n    \"next\": \"https://api.simplesat.io/api/answers/?page=2\",\n    \"previous\": null,\n}\n\n

Stop paging when the next attribute is null.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Pagination","slug":"pagination"}],"owner":"457268","collectionId":"c01b0216-f01f-4b81-8db5-e4cd6958e14e","publishedId":"SVfRt7WJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4EC677"},"publishDate":"2019-08-30T03:51:15.000Z"},"item":[{"name":"Answers","item":[{"name":"List Answers","id":"05b3e9ee-7d3e-4546-a93a-4885715bb0eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/answers/","description":"

Fetch a list of all answers.

\n","urlObject":{"protocol":"https","path":["api","answers",""],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"1d41f0e6-6277-49d8-b35a-d1c04fec2235","name":"List Answers","originalRequest":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/answers/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 Aug 2019 03:38:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"97863"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.11.4"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,PUT,PATCH,POST,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization"}],"cookie":[],"responseTime":null,"body":"{\n \"answers\": [\n {\n \"id\": 896642,\n \"question\": {\n \"id\": 5833,\n \"modified\": \"2019-07-10T12:12:10.340206Z\",\n \"title\": \"How did we do?\",\n \"metric\": \"csat\",\n \"type\": \"multipleChoiceScale\"\n },\n \"follow_up_answer\": {\n \"id\": 896645,\n \"modified\": \"2019-08-28T12:54:49.925488Z\",\n \"comment\": \"YOU GUYS ROCK!!!\",\n \"question\": {\n \"id\": 5836,\n \"modified\": \"2019-07-10T12:12:10.371734Z\",\n \"title\": \"Was there anything in particular we did that delighted you?\",\n \"type\": \"comment\"\n }\n },\n \"sentiment\": \"positive\",\n \"channel\": \"connectwise\",\n \"customer\": {\n \"id\": 1095622,\n \"modified\": \"2019-08-28T12:08:00.632102Z\",\n \"name\": \"John Smith\",\n \"email\": \"jsmith@gmail.com\",\n \"company\": {\n \"name\": \"Smith Inc\"\n }\n },\n \"ticket\": {\n \"id\": 114823,\n \"external_id\": \"111311\",\n \"subject\": \"Fix my broken printer\",\n \"collaborators\": [\n {\n \"role\": \"Most time entered\",\n \"team_member\": {\n \"id\": 234,\n \"name\": \"Sarah Oleary\",\n \"email\": null,\n \"external_id\": \"soleary\"\n }\n },\n {\n \"role\": \"Opened by\",\n \"team_member\": {\n \"id\": 432,\n \"name\": \"JD Pederson\",\n \"email\": null,\n \"external_id\": \"jpederson\"\n }\n },\n {\n \"role\": \"Owner\",\n \"team_member\": {\n \"id\": 433,\n \"name\": \"Sarah Oleary\",\n \"email\": null,\n \"external_id\": \"soleary\"\n }\n },\n ],\n \"team_member\": {\n \"id\": 3606,\n \"name\": \"Sal Mon\",\n \"email\": null,\n \"external_id\": \"smon\"\n },\n \"custom_attributes\": {\n \"board\": \"Help Desk\",\n \"department\": null,\n \"zendesk_channel\": \"chat\"\n }\n },\n \"ip_address\": null,\n \"is_primary\": true,\n \"rating\": 3,\n \"survey\": {\n \"id\": 2632,\n \"modified\": \"2019-07-10T12:14:25.509935Z\",\n \"name\": \"CSAT Survey\"\n },\n \"answer_label\": \"Great, I'm satisfied\",\n \"comment\": null,\n \"tags\": [\n {\n \"id\": 123,\n \"name\": \"Professional\"\n },\n {\n \"id\": 124,\n \"name\": \"Response time\"\n }\n ],\n \"created\": \"2019-08-28T12:54:09.913638Z\",\n \"modified\": \"2019-08-28T12:54:09.913663Z\",\n \"session\": 48954\n }\n ]\n}"}],"_postman_id":"05b3e9ee-7d3e-4546-a93a-4885715bb0eb"}],"id":"6d36032b-209d-4bf3-b858-8ae9f844c153","description":"

Answers are individual responses to questions.

\n

Answers model

\n

The answers object contains the following fields.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
idNumberID for answer in Simplesat.
questionObjectDetails about the answer's question.
follow_up_answerObjectDetails about the answer's (optional) follow-up question.
sentimentStringEach rating is mapped to a sentiment: `positive, neutral, or negative`.
channelStringThe channel \"source\" the answer arrived from.
customerObjectDetails about the customer who provided the answer.
ticketObjectDetails about the ticket the answer is connected to.
ticket collaboratorsObjectDetails about people associated with the ticket.
ip_addressStringIP address of respondent.
is_primaryBooleanTrue/false value of whether an answer comes from the first \"primary\" question of a survey.
ratingNumberNumber value for answer (can be 0-10 depending on the question).
surveyObjectDetails about the survey the answer belongs to.
answer_labelStringText label associated with the rating (Great, I'm satisfied!).
commentStringThe follow-up \"reason\" for a rating. Usually a comment, but could be a multiple choice answer.
tagsArrayTags associated with a response. Returns the tag ID and tag name as a string.
createdDateTimeDate answer was created.
modifiedDateTimeDate answer was modified.
sessionNumberSurveys with multiple questions can be grouped by session.
\n

\n\n

Available parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredComments
modified__gteDateTimenoFilter answers modified after a date. Example datetime field: 2019-08-02T00:00:00.000000Z
modified__lteDateTypenoFilter answers modified before a date.
\n

Follow-up answers

\n

Simplesat surveys support a \"follow-up question\" feature that allows users to gain additional context about a specific answer. If a question contains a follow-up question, Simplesat will bind the answer and follow-up answer as a single answer. The follow-up answer's details can be found in the follow_up_answer object.

\n","event":[{"listen":"prerequest","script":{"id":"393df57f-482c-438c-abc0-a18eb1b4cbf0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cf3bf691-d9e4-44b5-9ee6-abd6dea12ba1","type":"text/javascript","exec":[""]}}],"_postman_id":"6d36032b-209d-4bf3-b858-8ae9f844c153"},{"name":"Customers","item":[{"name":"Create or Update Customer","id":"c956fd32-4bd1-4e9a-8029-98056596a439","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Simplesat-Token","type":"text","value":"{{Your access token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/customers/create-or-update/","description":"

Customers can be created or updated via a POST method to https://api.simplesat.io/api/customers/, which accepts a JSON object describing the customer.

\n","urlObject":{"protocol":"https","path":["api","customers","create-or-update",""],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"41c04511-3e56-4427-b37e-63691cd781a9","name":"Create or Update Customer","originalRequest":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"{{Your access token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"custom_attributes\": {\n \"company_status\": \"Active\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/customers/create-or-update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234,\n \"created\": \"2018-11-08T09:34:15.524170Z\",\n \"modified\": \"2020-04-13T08:27:14.857438Z\",\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"company\": {\n \"name\": \"Rindge, Inc.\"\n },\n \"source\": \"Simplesat API\",\n \"custom_attributes\": {\n \"company_status\": \"Active\"\n }\n}"}],"_postman_id":"c956fd32-4bd1-4e9a-8029-98056596a439"}],"id":"5722f835-509e-4024-89e8-e79a6adc5ccc","description":"

Customers are individual people who can receive and provide answers to surveys.

\n

Simplesat doesn't yet have a separate Companies model. For now, any company-specific details are nested in the customers object.

\n

Customers model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
idNumberThe Simplesat defined id representing the customer.
createdDateTimeThe time when the customer was created.
modifiedDateTimeThe time when the customer was modified.
nameStringFirst and last name of the customer.
emailStringEmail address of the customer.
companyObjectDetails about the company the customer belongs to.
custom_attributesObjectCustom attributes associated with the customer.
\n
","event":[{"listen":"prerequest","script":{"id":"89c099e6-1a96-438b-b8dd-e636fd38f993","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d7e5ac6f-9e9e-40dd-a440-a0ba6440c558","type":"text/javascript","exec":[""]}}],"_postman_id":"5722f835-509e-4024-89e8-e79a6adc5ccc"}],"event":[{"listen":"prerequest","script":{"id":"9f71ac05-aa72-4e56-aea4-5a18b8bfef57","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6990bec0-ea9b-49d9-ac43-5720e7efab4c","type":"text/javascript","exec":[""]}}]}