Get a Check-in - StudentPulse documentation

The source describes reading Check-in details, including its questions and template.

The endpoint summary uses GET /checkin/:uuid. The detailed section uses GET /checkin/:id. Confirm which identifier the current API accepts before you build a request.

See the API overview for the source base URL and authentication.

Example response

This example preserves the source response structure. Syntax has been corrected to valid JSON. Names and identifiers are illustrative.

{
  "success": true,
  "data": {
    "id": 123,
    "name": "Course feedback",
    "main_language": "en",
    "uuid": "EXAMPLE_CHECK_IN_UUID",
    "number_of_students": 36,
    "short_code": 123456,
    "link": "https://app.studentpulse.io/feedback/EXAMPLE_CHECK_IN_UUID",
    "next_round_date": "2025-10-10 00:00:00",
    "questions": [
      {
        "id": 2,
        "description": "How likely would you be to recommend your institution?"
      }
    ],
    "template": {
      "id": 12,
      "name": "Course feedback template",
      "supported_languages": ["en", "da"]
    }
  },
  "message": ""
}

Source response fields

Field	Description
`data.id`	The numeric Check-in ID.
`data.uuid`	The Check-in UUID.
`data.name`	The Check-in name.
`data.main_language`	The main language code.
`data.number_of_students`	The student count.
`data.short_code`	The short code for the Check-in.
`data.link`	The Check-in URL.
`data.next_round_date`	The next round date shown in the source example.
`data.questions`	The question IDs and descriptions.
`data.template`	The template ID, name, and supported languages.

The source does not define required fields, nullable values, timezone behavior, or error responses.