Quickstart - Primula API

Prerequisites

Before you begin, you must have:

A Primula username and password
The hostname of your API deployment (examples below use api.example.com)

Get started

Create a session

Exchange your credentials for an access token.

curl -X POST https://api.example.com/primula/api/v3/sessions \
  -H "Content-Type: application/json" \
  -d '{"username": "example.user", "password": "<your-password>"}'

The response returns HTTP 201 with your tokens:

{
  "access_token": "<access-token>",
  "refresh_token": "<refresh-token>"
}

Call a protected endpoint

Send the access token in the Authorization header.

curl https://api.example.com/primula/api/v3/schools \
  -H "Authorization: Bearer <access-token>"

Explore the API

Every endpoint is documented in the API reference, where you can also try requests from your browser.

V3 has no refresh or logout endpoint. When your token stops working, create a new session.

​Prerequisites

​Get started

Prerequisites

Get started