Base URL
All API requests use the following base URL:Versioning
The API is currently at v1, which is the only available version. Version information is included in the URL path.Content Type
All API requests and responses useapplication/json format. Include the following header in all requests:
Authentication
NativeMessage API supports two authentication methods:- JWT Bearer Token: Include
Authorization: Bearer <token>header - API Key: Include
X-API-Key: <your-api-key>header
See the Authentication guide for detailed setup instructions.
Pagination
List endpoints support pagination using query parameters:| Parameter | Description | Default | Max |
|---|---|---|---|
page | Page number to retrieve | 1 | - |
per_page | Number of items per page | 20 | 100 |
Response Format
Success Response (Single Resource)
Success Response (List)
Error Response
HTTP Status Codes
| Code | Description |
|---|---|
| 200 | OK - Request succeeded |
| 201 | Created - Resource successfully created |
| 400 | Bad Request - Invalid request parameters |
| 401 | Unauthorized - Missing or invalid authentication |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource does not exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - Server-side error |
Rate Limiting
API requests are limited to 200 requests per minute per tenant. When exceeded, the API returns a429 status code.
See the Rate Limits guide for best practices and optimization strategies.