Overview

The Team Inbox API allows you to build custom integrations, automate workflows, and extend functionality programmatically. Base URL: https://your-domain.com/api/v1

Quick Start

const response = await fetch('https://your-domain.com/api/v1/conversations', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const conversations = await response.json();

Authentication

All API requests require an API key:
curl https://your-domain.com/api/v1/conversations \
  -H "Authorization: Bearer YOUR_API_KEY"
Learn more about authentication →

Rate Limits

  • 1,000 requests/hour per API key
  • 100 requests/minute per IP address
Rate limit headers:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1701234567

Endpoints

Response Format

All responses use JSON:
{
  "data": {
    "id": "conv_123",
    "status": "open",
    "customer": {
      "name": "John Smith",
      "phone": "+1234567890"
    }
  },
  "meta": {
    "timestamp": "2025-11-29T10:30:00Z"
  }
}

Error Handling

Errors include status codes and messages:
{
  "error": {
    "code": "validation_error",
    "message": "Phone number is required",
    "field": "phone"
  }
}
StatusMeaning
200Success
201Created
400Bad Request
401Unauthorized
404Not Found
429Rate Limit Exceeded
500Server Error

Pagination

List endpoints support pagination:
GET /api/v1/conversations?page=2&limit=50
Response includes pagination meta:
{
  "data": [...],
  "meta": {
    "page": 2,
    "limit": 50,
    "total": 247,
    "pages": 5
  }
}

SDKs

Official SDKs coming soon. Community SDKs:
  • JavaScript/TypeScript
  • Python
  • PHP
  • Ruby

Support