> ## Documentation Index
> Fetch the complete documentation index at: https://docs.studentpulse.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Authentication and scope for the draft StudentPulse V1.5 Check-in API.

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

<Warning>
  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.
</Warning>

## Base URL

```text theme={null}
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.

```http theme={null}
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](/api-reference/create-check-in) |
| Delete a Check-in | `DELETE /checkin/delete` | [Delete](/api-reference/delete-check-in) |
| Get a Check-in | `GET /checkin/:uuid` in the summary; `GET /checkin/:id` in the detail | [Get](/api-reference/get-check-in) |
| Distribute a Check-in | `POST /checkin/distribute` in the summary; `POST /checkin/reminder` in the detail | [Distribute](/api-reference/distribute-check-in) |

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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.