Heyzack CRM REST API overview

The Heyzack CRM REST API lets you integrate portal functionality—messaging, connections, and more—directly into your own applications. Every endpoint uses JSON over HTTPS, requires a Bearer token for authentication, and wraps successful responses in a consistent data envelope.

Base URL

All API requests are made to:

https://<your-portal-domain>/api/v1

Replace <your-portal-domain> with the domain of your Heyzack CRM instance.

Versioning

The current API version is v1. The version is embedded in every URL path (/api/v1/...). When a new major version is released, the older version remains available at its existing path until a deprecation period ends.

Request format

For POST endpoints, send a JSON body and include the Content-Type header:

Content-Type: application/json

GET endpoints accept parameters as URL query strings instead.

Authentication

Every request requires a Bearer token in the Authorization header:

Authorization: Bearer <your-token>

See Authentication for details on obtaining and using tokens.

Response format

Successful responses return HTTP 200 and wrap the result in a data key:

{
  "data": { ... }
}

Error responses

When a request fails, the API returns a JSON object with an error key describing what went wrong:

{
  "error": "Error message here"
}

HTTP status codes