REST API Access

Plan requirement

REST API access is available on the Enterprise plan.

The REST API lets you integrate the platform with external systems — HRMSs, Zapier workflows, custom dashboards, or any tool that can make HTTP requests.

Generate an API key

1. Go to Settings → API Keys
2. Click New API Key
3. Enter a label (e.g. "HubSpot integration" or "Zapier")
4. Select the scopes the key needs (see table below)
5. Click Create
6. Copy the key — it is shown only once

warning

Store your API key securely (e.g. in a secrets manager or environment variable). The platform does not show the full key again after creation.

Scopes

Scope	Access granted
users:read	List and retrieve user records
courses:read	List and retrieve course records
enrollments:read	List enrollments
enrollments:write	Create and update enrollments
certificates:read	List certificates

Select only the scopes your integration needs.

Base URL

https://t-b-lms.techarix.com

All API paths are relative to this base URL.

Authentication

Include your API key in the Authorization header of every request:

Authorization: Bearer lms_your_api_key_here

Available endpoints

List users

GET /api/v1/users

curl https://t-b-lms.techarix.com/api/v1/users \
  -H "Authorization: Bearer lms_xxx"

Response:

{
  "data": [
    {
      "id": "usr_abc123",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "role": "student",
      "created_at": "2026-01-15T09:00:00Z"
    }
  ],
  "pagination": { "page": 1, "per_page": 50, "total": 142 }
}

List courses

GET /api/v1/courses

Returns all published courses in your organization.

List enrollments

GET /api/v1/enrollments

Optional query parameters: ?student_id=usr_abc123, ?course_id=crs_xyz789

Create enrollment

POST /api/v1/enrollments

curl -X POST https://t-b-lms.techarix.com/api/v1/enrollments \
  -H "Authorization: Bearer lms_xxx" \
  -H "Content-Type: application/json" \
  -d '{"student_id": "usr_abc123", "course_id": "crs_xyz789"}'

Response: 201 Created with the enrollment object.

List certificates

GET /api/v1/certificates

Optional query parameters: ?student_id=usr_abc123, ?course_id=crs_xyz789

Rate limits

Limit	Value
Requests per hour	1,000
Requests per minute	60

When a rate limit is exceeded, the API returns 429 Too Many Requests with a Retry-After header indicating when to retry.

Key rotation and revocation

To rotate a key:

1. Create a new API key in Settings → API Keys
2. Update your integration to use the new key
3. Delete the old key

To revoke a key immediately:

1. Go to Settings → API Keys
2. Click Revoke next to the key

Revoked keys stop working instantly.

Full API reference

The complete API reference with all parameters, error codes, and response schemas is available at:

https://t-b-lms.techarix.com/api/v1/docs

Contact hello@techarix.com if you need access or assistance with a specific integration.