ChatMaxima API - Getting Started and API Key Setup

What is the ChatMaxima API

The ChatMaxima API is a REST API that lets you access your workspace data from your own code. Instead of working only inside the dashboard, you can read your conversations and sync them into other systems automatically.

A common use is exporting your conversation history (contact name, mobile and full message history) into a CRM, a database, or a data warehouse on a schedule. Your system calls the API, ChatMaxima returns the data as JSON, and you load it wherever you need it.

Key things to know:

• Version - the current API is v2.
• Transport - every request is made over HTTPS and returns JSON.
• Base URL - all endpoints live under https://chatmaxima.com/api/v2.
• Auth - requests are authenticated with an API key that is unique to your workspace.

Note: The API is the pull alternative to webhooks. You call it on your own schedule and page through whatever is new, so you stay in control of when and how often data is fetched.

Get your API key

Your API key lives in the Developer portal, on the Settings page. It is created automatically for your workspace the first time you open that page.

1. Open the Developer portal at https://chatmaxima.com/developer/.
2. Sign in with your ChatMaxima account if you are not already logged in.
3. Go to Settings (the API Key page) at https://chatmaxima.com/developer/settings/.
4. Your API key is shown on the page. Click Copy API Key to copy it.
5. If you manage more than one workspace, use the team switcher in the top menu to select the right workspace first. Each workspace has its own key, and a key only returns data for the workspace it belongs to.

Note: Treat the API key like a password. It carries the permissions of your workspace, so keep it secret and store it server side only. Never put it in a browser, a mobile app, or any public code.

Make your first request

Send the key as the raw value of the Authorization header. The example below pulls the first page of your conversation history using the Conversations Export endpoint.

curl -G https://chatmaxima.com/api/v2/conversations/export/ \
  -H "Authorization: YOUR_API_KEY" \
  --data-urlencode "limit=5"

A successful call returns the standard response envelope:

{
  "status": "success",
  "code": 200,
  "message": "Conversation export",
  "data": [],
  "meta": {}
}

If the key is missing or wrong, you get a 401 with an error object instead:

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key provided."
  }
}

Available endpoints

• Conversations Export - Pull your conversation history (contact name, mobile and full message history) as flat rows for a daily sync into an external system.

Explore interactively

You can try the API live, with your own key, in the interactive developer reference:

https://chatmaxima.com/developer/v2/docs

Next steps

• Conversations Export API →
• ChatMaxima MCP →