API Reference

Getting Started

This page will help you get started with the Leexi public API.

Authentication

This is an HTTPS-only API. Authentication is based on API Key ID and Key Secret. The API Key ID and Key Secret is passed via HTTP Basic Authentication. This means Leexi expects to find an Authorization header with "Basic " and then KEY_ID:KEY_SECRET encoded in base 64.

# Key ID: KEY_ID
# Key Secret: KEY_SECRET
# KEY_ID:KEY_SECRET base64 encoded: S0VZX0lEOktFWV9TRUNSRVQ=

curl --header "Authorization: Basic S0VZX0lEOktFWV9TRUNSRVQ="  
     --location "<https://public-api.leexi.ai/v1/users">

You can generate an API key/secret pair by going to Leexi → Settings → Company Settings → API Keys, and clicking on add (requires a Leexi admin account).

Pagination

All routes have as optional query parameters

  • page : page number
  • items : number of items per page (1-100, default to 10)

Rate Limiting

The rate limit for this API is 100 requests/minute

Error Codes

  • 400 : Invalid request (invalid parameter values)
  • 401 : Unauthorized (API key is invalid)
  • 403 : Forbidden (API key doesn't have the right access)
  • 404 : Resource not found