Integrate your applications with NiceHatCRM
Our RESTful API allows you to integrate NiceHatCRM with your existing systems and build custom applications.
The NiceHatCRM API uses standard HTTP methods and returns JSON responses. All requests require authentication using an API key, which you can generate in your account settings.
https://api.nicehatcrm.com/v1
All API requests require authentication using an API key. You can include your API key in the request headers:
Authorization: Bearer YOUR_API_KEYKeep your API key secure and never share it publicly. If you believe your key has been compromised, revoke it immediately and generate a new one.
To ensure the stability of our API, we enforce rate limits on all requests:
| Plan | Rate Limit | Burst Limit |
|---|---|---|
| Basic | 100 requests per minute | 150 requests |
| Premium | 500 requests per minute | 750 requests |
| Enterprise | 1,000 requests per minute | 1,500 requests |
Rate limit information is included in the response headers:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1617304800The API uses standard HTTP status codes to indicate the success or failure of a request:
| Code | Description |
|---|---|
| 200 | OK - The request was successful |
| 201 | Created - The resource was successfully created |
| 400 | Bad Request - The request was invalid or cannot be served |
| 401 | Unauthorized - Authentication is required or has failed |
| 403 | Forbidden - The server understood the request but refuses to authorize it |
| 404 | Not Found - The requested resource could not be found |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - Something went wrong on our end |
Error responses include a JSON object with details about the error:
{
"error": {
"code": "validation_error",
"message": "The request was invalid",
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
}Current version: v1
Our developer support team is here to help you integrate with NiceHatCRM.
Contact Developer Support