API overview - StudentPulse documentation

The source document describes an API for creating, reading, deleting, and distributing Check-ins.

This reference comes from an API section marked “in progress” in November 2025. It has not been checked against the current implementation. Confirm paths, identifiers, and response formats with StudentPulse before you integrate.

Base URL

https://api.studentpulse.io/v1/

Authentication

The source specifies an API key supplied through StudentPulse. Send it as a Bearer token in the Authorization header.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Keep API keys in server-side configuration. Do not add them to Check-in links or public frontend code.

Operations

Operation	Source contract	Reference
Create a Check-in	`POST /checkin/create`	Create
Delete a Check-in	`DELETE /checkin/delete`	Delete
Get a Check-in	`GET /checkin/:uuid` in the summary; `GET /checkin/:id` in the detail	Get
Distribute a Check-in	`POST /checkin/distribute` in the summary; `POST /checkin/reminder` in the detail	Distribute

The conflicting paths are preserved here so you can see what needs confirmation. This draft does not provide an interactive API playground.

Confirm before development

The current base URL and API key setup.
Whether Get uses a numeric ID or UUID.
The current distribution endpoint.
Date formats and the structure of replacement variables.
Error responses, limits, and retry behavior.
The effect of deleting a Check-in and its associated data.