Skip to main content

API Access

Create a Client ID and Secret in BOLT XLR, hand them to your developer with the API Developers Guide, and your own software can read and update your jobs, customers, schedule, and more. You choose whether each credential can change data or only read it.

API AccessCreate Credential
Connection DetailsGive these to the software that connects, along with a credential below.
API Base URLhttps://yourcompany.boltxlr.com/apiCopy
Token URLhttps://yourcompany.boltxlr.com/api/auth/v1/oauth/tokenCopy
Tenant IDtenant-yourcompanyCopy
Your developer can follow the API Developers Guide to connect.
Credentials
Name
Role
Secret
Actions
Accounting Sync
API Full
Ends in xk3Q
Regenerate SecretRevoke
Owner Dashboard
API Readonly
Ends in p7Zd
Regenerate SecretRevoke
Old Portal TestRevoked
API Readonly
Ends in m2Lw
Your software asks for a token
POST /api/auth/v1/oauth/tokenAuthorization: Basic ••••••••X-Tenant-ID: tenant-yourcompanygrant_type=client_credentials
200 OK"token_type": "Bearer", "expires_in": 3600
Then every call carries the token and the Tenant ID.

Credentials You Control

An admin creates each credential on the API Access page, under Integrations.

  • One per System. Name a credential for each program that connects, so cutting one off never touches the rest.
  • Secret Shown Once. BOLT XLR keeps only a one-way hash, so copy the secret when it is created.
  • Regenerate or Revoke. The old secret, and every token issued with it, stops working within a minute.

Full or Readonly

Each credential takes one of two built-in roles, set when it is created.

  • API Full. Reads and changes jobs, customers and leads, scheduling, time, equipment, materials, files, templates, and workflows, and can send quotes, documents, and invoices to customers.
  • API Readonly. Reads the same data, and is refused on any change.
  • Off Limits to Both. Managing people, roles, billing, and integrations, approvals and sign-offs, and recording a customer's signature.

Built on Standards

Your software asks your company's Token URL for a token, then calls the API with it.

  • OAuth 2.0 Client Credentials. Standard OAuth libraries work as they are. Each token lasts an hour.
  • Your Company Only. Every request carries your Tenant ID, and a credential can never reach another company's data.
  • Changes Under Its Name. What a credential saves shows under its name, such as Accounting Sync (API), in activity and history.

A Guide Your Developer Can Follow

The API Developers Guide is in the app, under Integrations, for anyone at your company who signs in.

  • Every Endpoint. Jobs, customers and leads, scheduling, time, equipment, materials, files and photos, templates, workflows, and the people directory.
  • Copy AI Prompt. A ready-made prompt with your company's details and every endpoint, for the AI assistant your developer uses. It never holds a Client ID or Secret.
  • Copy and Download. A copy button on every example, and the whole guide as Markdown.

Common Questions

Does BOLT XLR have an API?

Yes. An admin creates API credentials under Integrations, and your software uses them to read and update your BOLT XLR data over a REST API secured with OAuth 2.0.

Can an API credential change our data?

Only an API Full credential can. API Readonly reads the same data and is refused on any change, and neither can manage people, roles, billing, or integrations.

What if a secret gets out?

An admin regenerates or revokes the credential, and the old secret and every token issued with it stop working within a minute.

Every plan includes API access.

See Pricing