Quickstart

In five steps, you’ll make your first request: get a token, set up the headers, find or create a user, and parse the response.

Get credentials

The school owner can create an API key on their own: go to Manage → School → For developers → API keys (/manage/school/api-keys) — this is where a service user (API client) is created and a token is issued. If you prefer, contact support — we’ll help with the setup.You’ll need three values for requests:

Authorization — the API token (used as Bearer <TOKEN>; shown in full only at the moment of creation or rotation — save it right away);
Seller-Id — the numeric ID of the seller (the account the school belongs to);
School-Id — the numeric ID of the school.

Both IDs are on the same API keys page, in the Integration data → Identifiers card — clicking it copies a string like Seller-Id: 123; School-Id: 456.Save the values to environment variables — the examples below use them:

export EXODE_TOKEN='...'   # API token
export SELLER_ID=123       # Seller-Id
export SCHOOL_ID=456       # School-Id

Store the token in environment variables, not in code or in the repository.

Set up the headers

All requests are made with three required headers:

Request headers

string

required

The service user’s API token in the Bearer YOUR_TOKEN format. The school owner issues the token in the admin panel: Manage → School → For developers → API keys — see the “Authentication” section for details.

integer

required

The numeric ID of the seller — the account the school belongs to. Copy it on the API keys page, in the Integration data → Identifiers card. The token’s permissions are checked against this ID.

integer

required

The numeric ID of the school, found in the same place as Seller-Id. The value must match the seller’s school — otherwise a 400 error with cause: "ForbiddenSchoolMismatch" is returned.

Make your first request — find a user

Check access with a safe read method — user/find:

curl --location 'https://api.exode.biz/saas/v2/user/find?extId=crm_12345' \
  --header "Authorization: Bearer $EXODE_TOKEN" \
  --header "Seller-Id: $SELLER_ID" \
  --header "School-Id: $SCHOOL_ID"

const axios = require('axios');

const client = axios.create({
  baseURL: 'https://api.exode.biz/saas/v2',
  headers: {
    Authorization: `Bearer ${process.env.EXODE_TOKEN}`,
    'Seller-Id': process.env.SELLER_ID,
    'School-Id': process.env.SCHOOL_ID,
  },
});

const { data } = await client.get('/user/find', { params: { extId: 'crm_12345' } });
console.log(data.payload.user);

import os, requests

session = requests.Session()
session.headers.update({
  'Authorization': f"Bearer {os.environ['EXODE_TOKEN']}",
  'Seller-Id': os.environ['SELLER_ID'],
  'School-Id': os.environ['SCHOOL_ID'],
})

r = session.get('https://api.exode.biz/saas/v2/user/find', params={'extId': 'crm_12345'})
print(r.json()['payload']['user'])

extId is your own user identifier (for example, an ID from your CRM): a string of up to 50 characters without / or spaces, unique within the school. If the user is not found, the method returns 200 and payload.user: null — this is not an error.

On method pages, the cURL examples write the headers as {{ sellerId }} and {{ schoolId }} — these are Postman collection variables. In a terminal, replace them with the numeric IDs or $SELLER_ID and $SCHOOL_ID.

Create a user

If the user doesn’t exist yet, create them with the user/create method. The login and password are sent to the user automatically if there is a delivery channel: email, phone (with an SMS provider connected) or tgId — see the method page for details.

cURL

curl --location 'https://api.exode.biz/saas/v2/user/create' \
  --header "Authorization: Bearer $EXODE_TOKEN" \
  --header "Seller-Id: $SELLER_ID" \
  --header "School-Id: $SCHOOL_ID" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "email": "[email protected]",
    "extId": "crm_12345",
    "profile": { "firstName": "John", "lastName": "Doe" }
  }'

Parse the response

Every response is wrapped in { success, code, payload }. Check success/code, and on error — the cause field:

Success

{ "success": true, "code": 200, "payload": { "user": { "id": 123, "extId": "crm_12345" } } }

Error

{ "success": false, "code": 400, "cause": "EmailIsBusy", "message": "Email is busy", "error": "Email is busy" }

Here, EmailIsBusy means the email is already taken by another user of the school. In this case, you usually look up the existing user through user/find?login=<email> or use user/upsert, which creates or updates a user in a single call.For details on headers, the response format, errors, rate limits and pagination, see “Working with the API”.

What’s next

Key concepts

How the seller, school, courses, products and accesses are related.

Working with the API

Headers, response and error format, rate limits, pagination.

Webhooks

Receive platform events in your services.

API objects

Complete entity structures based on zod schemas.

Updated: 2026-09-25 14:33 UTC

Working with the API

Users

Staff (HR)

Groups

Courses

Access and sales

Reports and exports

Custom fields

Forms

Missing a method?

All objects

Request headers

What’s next

Key concepts

Working with the API

Webhooks

API objects

​Request headers

​What’s next

Key concepts

Working with the API

Webhooks

API objects

Request headers

What’s next