Last updated: 12 October 2026
/auth_token — POST (public, no token)Issues the Firebase ID token used to authenticate every other endpoint. The token has an expiration time of 15 to 30 minutes. To obtain your integration email and password, see Getting integration credentials or email admin@nicehms.com.
| Name | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Valid email (your Nice HMS integration credential). |
password | string | Yes | Non-empty password. |
{
"email": "integrator@example.com",
"password": "your-password"
}
{
"token": "eyJhbGciOiJSUzI1NiIsImtpZCI6..."
}
| Field | Type | Description |
|---|---|---|
token | string | Firebase ID token. Pass as Authorization: Bearer <token> on all other endpoints. |
VALIDATION_ERROR (400) — malformed body (bad email / missing password).UNAUTHORIZED (401) — invalid email or password.DB_ERROR (500) · INTERNAL_ERROR (500)Notes: This endpoint is public (no token required) and does not check subscription.
401 UNAUTHORIZED), obtain a fresh token by calling /auth_token again with the same email and password./auth_token once per session and reuse the token for all requests, rather than calling it before every endpoint.401 from another endpoint: the token is missing, malformed, expired, or not mapped to an organization. Get a new token from /auth_token and retry once.401 from /auth_token itself: the email or password is wrong — verify the credentials, or request a reset (see Getting integration credentials).500 from /auth_token: server-side failure — retry 2–3 times with backoff; escalate with the x-request-id if it persists.