Skip to main content

Getting Started

This guide walks you through connecting to the Vanillatots API.

Base URL​

https://api.vanillatots.com

Authentication​

All endpoints (except health checks) require a valid JWT Bearer token issued by Auth0.

curl -X GET https://api.vanillatots.com/schools \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Multi-Tenancy​

Most endpoints require a school context. Pass the school's UUID via the X-SCHOOL-ID header:

curl -X GET https://api.vanillatots.com/students \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-SCHOOL-ID: your-school-uuid"

Health Check​

Verify the API is running:

curl https://api.vanillatots.com/health

Expected response:

{
  "status": "UP"
}

Common Response Patterns​

Pagination​

Paginated endpoints accept pageNumber (0-indexed) and pageSize query parameters:

GET /students?pageNumber=0&pageSize=25

Response:

{
  "data": [...],
  "totalElements": 150,
  "totalPages": 6,
  "currentPage": 0
}

Error Responses​

Errors follow a consistent format:

{
  "message": "Resource not found",
  "_embedded": {
    "errors": [...]
  }
}

Next Steps​