Skip to main content

Quick Start

This page walks through your first authenticated call to the Lexabit API.

Pick the right environment

Developing or testing? Use the staging host: https://api.staging.lexabit.com. The production host https://api.lexabit.com (shown in the examples) is only for applications running against the live environment — see Base URLs & environments.

Prerequisites​

  • A Lexabit account (a user with access to at least one tenant).
  • A bearer token for that account. See Authentication Overview for how to obtain one via POST /auth/v1/login.

Your first request​

Once you have a token, list the clients visible to your account:

curl https://api.lexabit.com/clients/v1 \
  -H "Authorization: Bearer <token>"

If the request succeeds, you'll receive a 200 OK response. If your account has no active operating scope selected, the API returns a 400 error instead ("Scope not set") — see Scopes & Workspaces for what a scope is and why requests are scoped to one.

A sample success shape​

Lexabit API responses use a consistent envelope: a data field containing the requested resource(s), and a meta field with request metadata, including a requestId you can reference in support requests:

{
  "data": [
    { "...": "client fields" }
  ],
  "meta": {
    "requestId": "..."
  }
}

The exact shape of data varies per endpoint — see the API Reference for the full schema of each response.

Next steps​