Quickstart

Generate an API key

Open the Developer API page, enter a descriptive key name, and select Generate key.Copy the key immediately. TrainerTwin only displays the full value once.

Store the key on your server

Save the key in your platform’s secret manager or server environment.

TRAINERTWIN_API_KEY=tt_your_key

Do not put this value in frontend environment variables, source control, logs, or screenshots.

List your learners

Send the key in the x-api-key header.

curl "https://dash.trainertwin.com/api/v1/users" \
  --header "x-api-key: $TRAINERTWIN_API_KEY"

A successful response returns organization learners, pending invitations, and pagination metadata.

{
  "users": [],
  "invitations": [],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 0
  }
}

Assign a published scenario

Use a learner ID returned by the users endpoint and a published scenario slug from your TrainerTwin dashboard.

curl "https://dash.trainertwin.com/api/v1/assignments" \
  --request POST \
  --header "x-api-key: $TRAINERTWIN_API_KEY" \
  --header "content-type: application/json" \
  --data '{
    "userId": "user_123",
    "scenario": "react-mock-interview"
  }'

Postman collection

Download the TrainerTwin API Postman collection and import it into Postman (File → Import). Then set the apiKey collection variable to your tt_... key — every request already sends it in the x-api-key header.

Get started

Guides

Resources

Postman collection

Next steps

Authentication

Assignments guide

​Postman collection

​Next steps

Authentication

Assignments guide

Postman collection

Next steps