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.

Managing API keys requires the Super Admin role — a regular Admin account won't see this page.

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
read:users	List and retrieve user records
read:courses	List and retrieve course records
read:enrollments	List enrollments and certificates — there's no separate certificates scope
write:enrollments	Create enrollments

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

There's no separate quota per API key today — all API traffic (the REST API included) shares the platform's general per-IP limit of 100 requests/minute. Exceeding it returns 429 Too Many Requests.

Key rotation and revocation

To rotate a key:

1. Go to Settings → API Keys
2. Click Rotate next to the key — a new key is generated and shown once; the old one stops working immediately
3. Update your integration with the new key

To revoke a key without replacing it:

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

Revoked keys stop working instantly.

Getting help

There's no separate hosted API reference site yet — this page is the full documentation for the available endpoints. Contact info@baccuracy.com if you need access or assistance with a specific integration.