Built LMS Help Center
Integrations

API Access

Create and manage OAuth applications and API keys for custom integrations.

Use API Access when an external system needs to call Built LMS through a custom integration.

Before you begin

You need permission to manage integrations or API access. You also need a secure place to store client secrets or API keys before creating credentials.

Before creating credentials, confirm:

  • Which system will use the credential.
  • Whether OAuth or an API key is the right pattern.
  • Which permissions the integration needs.
  • Who owns rotation and revocation.
  • Whether an IP allowlist should be used.

Choose OAuth or API keys

Use OAuth applications for apps

Use an OAuth application when an installed app, partner app, or custom client needs client credentials and redirect URIs.

OAuth applications are best when the external system has an application identity and needs token-based access.

Use API keys for server jobs

Use API keys for server-to-server automation, scheduled syncs, or backend jobs that do not need a user-facing OAuth flow.

Use Read Only when the integration only retrieves data. Use broader access only when the integration must write or manage records.

Create and manage credentials

Create an OAuth application

  1. Open Settings > Integrations > API Access.
  2. Open OAuth Applications.
  3. Select Create Application.
  4. Enter application name and description.
  5. Add redirect URIs when the app uses redirects.
  6. Choose default scopes.
  7. Save the application.
  8. Copy the client ID and secret to the secure storage location.

Do not share the client secret in chat, email, screenshots, or tickets.

Manage OAuth applications

Review existing applications for:

  • Application name.
  • Client ID.
  • Redirect URIs.
  • Default scopes.
  • Creation date.
  • Last used date.

Delete an application only when it should no longer work. Deleting an OAuth application permanently removes the application credentials and breaks integrations using those credentials.

Create an API key

  1. Open Settings > Integrations > API Access.
  2. Open API Keys.
  3. Select Create API Key.
  4. Enter name and description.
  5. Choose the shortest expiration that matches the integration's review cycle.
  6. Select only the permissions the integration needs.
  7. Add an IP allowlist when the integration runs from known addresses.
  8. Select Create API Key.
  9. Copy the generated key immediately.
  10. Store it securely.
  11. Select I've Saved My Key only after the key is stored.

Rotate API credentials

Rotate credentials when:

  • A secret may have been exposed.
  • An owner leaves the organization.
  • A vendor changes ownership.
  • The review cycle requires a fresh credential.
  • The integration no longer needs the same permissions.

Create the replacement credential first, update the external system, test the integration, then revoke the old credential.

Verify and support API access

Verify success

API access is ready when:

  • Credentials are stored securely.
  • Permissions match the integration's actual job.
  • Expiration and rotation owners are documented.
  • The external system can complete its test call or sync.
  • Audit logs show expected credential use.

Troubleshooting

On this page