Skip to main content

​
Get your API token

  1. Log in to your Inbox dashboard at inboxapp.com
  2. Navigate to Settings → API
  3. Click New API token
  4. Enter a name for your token and click Create
  5. Copy the token immediately — you won’t see it again
Store your API token securely. Never commit it to version control or share it publicly.

​
Using the token

Include your token in the Authorization header of every request: 
Authorization: Bearer YOUR_API_TOKEN

​
Environment variable setup

# Add to your shell profile or .env file
export INBOX_API_TOKEN="your_token_here"

​
Making requests

import axios from "axios";

const client = axios.create({
  baseURL: "https://inboxapp.com/api/v1",
  headers: {
    Authorization: `Bearer ${process.env.INBOX_API_TOKEN}`,
    "Content-Type": "application/json",
  },
});

const { data: team } = await client.get("/team");
console.log("Connected to:", team.name);
Expected response: 
{
  "id": "hzcai5t59nn9vsck3rbuepyg",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": null,
  "currency": "USD",
  "allowSupportAccess": false
}

​
Next steps

Quick start

Send your first message

Core concepts

Understand the data model

Error codes

All error types and recovery

Rate limits

API limits and backoff