Skip to main content
Welcome to the G-Tateth CRM API! This guide will help you get started with integrating our API into your application.

​
Quick Start

  1. Get your API key from Settings → Developer Console
  2. Make your first request using the API key
  3. Explore the API using our reference documentation

​
Authentication

The G-Tateth API uses API key authentication. Include your API key in the Authorization header: 
curl -H "Authorization: Bearer sk_live_your_api_key_here" \
  https://api.g-tateth.com/api/v1/conversations
See the Authentication page for more details.

​
Base URLs

  • Production: https://api.g-tateth.com
  • Staging: https://staging-api.g-tateth.com
  • Development: http://localhost:3001

​
Your First Request

Let’s list your conversations: 
curl -H "Authorization: Bearer sk_live_your_api_key" \
  https://api.g-tateth.com/api/v1/conversations
Response: 
{
  "success": true,
  "data": [
    {
      "_id": "...",
      "subject": "Customer inquiry",
      "status": "open",
      "channel": "email",
      "customerId": {
        "profile": {
          "firstName": "John",
          "lastName": "Doe",
          "email": "john@example.com"
        }
      }
    }
  ],
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 50,
    "totalPages": 2
  }
}

​
Using the SDKs

We provide official SDKs for popular languages to make integration easier.

​
JavaScript/TypeScript

npm install @g-tateth/sdk

import { createClient } from '@g-tateth/sdk';

const client = createClient({
  apiKey: 'sk_live_your_api_key'
});

const conversations = await client.conversations.list();
const customers = await client.customers.list();
See the JavaScript SDK documentation for more details.

​
Python

pip install gtateth-sdk

from gtateth import GtatethClient

client = GtatethClient(api_key='sk_live_your_api_key')
conversations = client.conversations.list()
customers = client.customers.list()
See the Python SDK documentation for more details.

​
Rate Limits

Rate limits are applied per API key based on your plan:
  • Starter/Standard: 500 requests/hour
  • Professional/Premium: 5,000 requests/hour
  • Enterprise: 50,000 requests/hour
Rate limit information is included in response headers:
  • X-RateLimit-Limit: Your limit
  • X-RateLimit-Remaining: Remaining requests
  • X-RateLimit-Reset: When the limit resets (Unix timestamp)
See the Rate Limits guide for more details.

​
Error Handling

All errors follow this format: 
{
  "success": false,
  "error": "Error message",
  "code": "ERROR_CODE"
}
Common error codes:
  • API_KEY_INVALID - Invalid API key
  • API_KEY_EXPIRED - API key expired
  • RATE_LIMIT_EXCEEDED - Rate limit exceeded
  • PERMISSION_DENIED - Insufficient permissions
  • TENANT_SUSPENDED - Tenant account suspended

​
Next Steps