Answers

Get answer by ID

Get an answer by ID.

Required scopes: read answers

get/api/v1/answers/{answer_id}

Request

  • Base URL: https://api.simplesat.io
  • URL: https://api.simplesat.io/api/v1/answers/{answer_id}
  • Auth: API key in header X-Simplesat-Token

Path parameters

answer_idstring required

The ID of the answer to retrieve

Response

Successful response

choicestring
choice_labelstring
choicesstring[]
sentimentstring
commentstring
follow_up_answerstring
follow_up_answer_choicestring
follow_up_answer_choicesstring[]
createdstring date-time
modifiedstring date-time
published_as_testimonialboolean
response_idinteger

Example response

{
  "id": 1,
  "choice": "3",
  "choice_label": "Okay, but not great",
  "choices": null,
  "comment": null,
  "follow_up_answer": null,
  "follow_up_answer_choice": "yes",
  "follow_up_answer_choices": null,
  "published_as_testimonial": false,
  "created": "2024-01-01T00:00:00Z",
  "modified": "2024-01-01T00:00:00Z",
  "question": {
    "id": 1,
    "text": "How did we do?",
    "metric": "csat"
  },
  "sentiment": "neutral",
  "survey": {
    "id": 1,
    "name": "Follow-up CSAT"
  },
  "response_id": 1,
  "topics": [
    {
      "id": 1,
      "name": "Response time",
      "description": "How quickly the team responded to the request.",
      "sentiment": "positive"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.