Skip to main content
Manage your API keys programmatically. API keys allow you to authenticate requests to the G-Tateth API.
These endpoints require JWT authentication (user login), not API key authentication.

List API Keys

string
Filter by environment: production or staging
boolean
Filter by active status: true or false
integer
Page number (default: 1)
integer
Items per page (default: 20)
boolean
true
array
Array of API key objects
number
Total number of API keys
number
Current page number
number
Items per page
number
Total number of pages

Create API Key

body
required
Name for the API key (e.g., “Production API Key”)
body
Environment: production or staging (default: production)
body
required
Array of permission strings (e.g., ["read:conversations", "write:customers"])
body
Expiration date (ISO 8601 format)
body
Automatic rotation policy:
body
Per-key rate limit override:
body
Array of allowed IP addresses
boolean
true
string
The full API key (only shown once!)
string
First 8 characters for display
Save the API key immediately - it will not be shown again after this response!

Get API Key

string
required
API key ID

Update API Key

string
required
API key ID
body
New name for the API key
body
Updated permissions array
body
Activate or deactivate the key

Revoke API Key

string
required
API key ID

Delete API Key

string
required
API key ID
This action cannot be undone!

Get API Key Usage

string
required
API key ID
string
Month in YYYY-MM format (default: current month)
boolean
true
number
Total requests in the month
object
Requests broken down by endpoint
object
Requests broken down by HTTP method