saas/v2/ prefix.
Base URL
https://api.exode.biz/saas/v2/<module>/<method> — for example, https://api.exode.biz/saas/v2/user/create.
Authentication
Requests are made on behalf of a service user (API client) — a school employee with a configured set of permissions and their own API token.- Authenticate with the
Authorization: Bearer <TOKEN>header. - The token does not expire, and you can revoke it at any time.
- The token must belong to a user with the API client flag (a service user created on the
API keys page gets it) — otherwise SaaS endpoints return
403Forbidden, even if all other permissions are in place.
How to get the token and IDs
1
Create an API key
The school owner opens Manage → School → For developers → API keys (
/manage/school/api-keys) and creates a key —
this also creates a service user and issues a token. A school can have at most 5 keys.
The same page lists the keys with a token preview and issue date, and lets you rotate (reissue) the token.2
Save the token
Copy the token right away — it is shown in full only once (see below). This is the value of the
Authorization: Bearer <TOKEN> header.3
Copy the Seller-Id and School-Id
On the same page, the “Integration data → Identifiers” card shows both IDs as
Seller-Id: 123; School-Id: 456 — click the line to copy it. These are numbers; they do not change when the token is rotated.The token is shown in full only at creation or rotation — save it right away. The key list
shows only a preview (the first and last 4 characters) and the issue date. Rotation issues a new token and
immediately revokes the old one.
A new key immediately receives all the permissions SaaS API methods need, so your first request works without setup.
The set depends on the school segment (
school.segment: Commerce — a commercial online school, Corporate —
corporate employee training): commercial schools additionally get “School Sales” and “School Refunds”,
corporate schools get “Staff Management” and “Staff browsing” (employee sync from HR/1C works out of
the box). You can change the set on the key’s page; for details, see
API key permissions.Required headers
Request headers
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.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.
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.In the examples on method pages, header values are written as
{{ sellerId }} and {{ schoolId }} —
these are variables of the Postman collection.
When running cURL from a terminal, replace them with the numeric IDs, and replace YOUR_TOKEN with your token.Response format
Every successful response is wrapped in a single structure:The method’s payload. Its structure is described on the page of the specific method and strictly matches the
response schema (extra fields are not returned).
Successful response
Error format
Errors are returned in the same envelope plus thecause, message, error fields and an optional data field:
Machine-readable cause code. Use it to build your error handling. Examples:
validation, Unauthorized,
Forbidden, EmailIsBusy, Rate.Human-readable error message. With
cause: "validation", it is an array of strings, one for each
violated rule (for example, ["extId must be shorter than or equal to 50 characters"]).Error example
Common cause codes (cause)
Access permissions (RBAC)
Each method checks the API key’s permissions — the checkboxes on the key’s page in the account. If a method lists several permissions, any one of them is enough. Without the required permission, the method returns401 with the message
Forbidden seller resource - permissions <Code>.
API key permissions
Which checkboxes to enable for your integration task, which methods each permission unlocks and which permissions a
new key receives.
Rate limits
Some methods are rate-limited. When the limit is exceeded, the API returns HTTP429 with cause: "Rate":
Rate limit exceeded
- The limit is counted per service user (token), separately for each method — by the route of the request.
- The
data.retryAfterfield tells you when you can retry the request. - Limits are listed on method pages. For example, generating exports is limited to 100 requests per hour.
Implement retries that respect
retryAfter, with exponential backoff for transient errors (429, 5xx).Pagination
List methods (.../list/raw, course progress, etc.) accept pagination parameters in the query:
A list method’s response is a single envelope with a page:
Page structure
Pass array parameters by repeating the key:
userIds=1&userIds=2&userIds=3. Pass ranges
as nested fields, for example createdAtDateRange[from] and createdAtDateRange[to].Request example
Updated: 2026-10-22 23:06 UTC