Current user profile and team management
GetSales API (1.0.0)
The GetSales API lets you manage your CRM data, automations, messaging, AI agents, and integrations programmatically.
All requests require two headers:
| Header | Description |
|---|---|
Authorization | Bearer {API_KEY} — your API key from Workspace Settings → API Keys |
Team-ID | Your team (workspace) ID |
All list endpoints support the following parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 20 | Items per page (max 100) |
offset | integer | 0 | Number of items to skip |
order_field | string | created_at | Field to sort by |
order_type | string | desc | Sort direction: asc or desc |
List responses return:
{
"data": [...],
"limit": 20,
"offset": 0,
"total": 150,
"has_more": true
}All errors follow a consistent format:
{
"error": {
"reason": "validation_error",
"message": "The name field is required.",
"data": {}
},
"message": "Validation failed",
"code": 422
}| Code | Reason | Description |
|---|---|---|
| 400 | bad_request | Missing required headers or malformed request |
| 401 | auth_exception | Invalid or expired API key |
| 402 | payment_required | Insufficient credits |
| 403 | access_denied | No access to this resource |
| 422 | validation_error | Request body validation failed |
Download OpenAPI description
Overview
URLGetSales Support
Languages
Servers
Mock server
https://api.getsales.io/_mock/bundled
Production
https://amazing.getsales.io