Skip to main content
The Braintest API v2 lets partner systems administer psychological tests and cognitive roadmaps programmatically. This reference covers the base URL, how to authenticate, the JSON response envelope, pagination behavior, and available server environments.

​
Base URL

All API requests are sent to the versioned base URL:

​
Authentication

Every request must include an API-KEY header containing your API key from the organizer panel:
For example:
If the key is missing, malformed, or invalid, the API returns a 401 Unauthorized error. If the key has been revoked or blocked, the API returns a 403 Forbidden error. See the Authentication page for full details on obtaining and managing your API keys.

​
Response envelope

Every JSON response from the Braintest API is wrapped in a standard envelope:
  • data — the actual response payload (varies by endpoint)
  • successful — boolean indicating whether the request succeeded
  • messages — array of informational or error strings
On error, successful is false, data is null, and messages contains one or more error descriptions. For a deeper explanation of the envelope structure and error handling patterns, see Response Envelope.

​
Pagination

List endpoints return up to 30 items per page. To paginate, append the page query parameter to the URL:
The response includes cursor links in the next and previous fields inside data when additional pages are available.