Built LMS Help Center

Developer API

Start building customer integrations with the Built LMS public API.

Use the Built LMS public API when another system needs to read, create, or update Built LMS data for your organization.

The public API is available under:

https://{your-built-lms-domain}/api/public/v1

Before you begin

You need:

  • Access to Admin Dashboard > Settings > Integrations > API Access.
  • Permission to manage API credentials.
  • An API key with only the permissions the integration needs.
  • A secure secret store for the API key.
  • The Built LMS domain for the organization you are integrating with.

Make your first request

Send the API key as a bearer token.

curl "https://{your-built-lms-domain}/api/public/v1/courses?limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

List responses include a data array and a meta object with pagination and organization context.

{
  "data": [],
  "meta": {
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "limit": 25,
    "offset": 0,
    "has_more": false
  }
}

Use the OpenAPI reference

Open the generated API Reference and Playground to browse endpoints, inspect schemas, enter auth, and send test requests through the docs proxy.

Built LMS also exposes the raw OpenAPI document from the application at:

GET /api/public/v1/docs/openapi

Use it for exact request bodies, response schemas, enum values, and endpoint details. The route requires a valid API key with docs:read permission and is cached for one hour.

curl "https://{your-built-lms-domain}/api/public/v1/docs/openapi" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o built-lms-openapi.json

Import the JSON into Postman, Swagger UI, or an OpenAPI-compatible SDK generator when you need an external copy of the same contract.

Common integration paths

Integration goalStart with
Explore and send API requestsAPI Reference and Playground
Sync users, groups, courses, and enrollment progressEndpoint Catalog
Connect a reporting warehouse or dashboardEndpoint Catalog
Receive event notifications in another systemWebhooks
Debug authentication, pagination, rate limits, or errorsAuthentication, Errors, and Limits

On this page