Hype Exchange Service API

See Integration from setup to go-live for both integration types, synchronization steps, and the required manual mapping after a custom integration becomes active.

Hype API follows REST principles and uses standard HTTP methods.

Getting started

To use Hype API:

• Set up an integration between your platform and a Hype customer to obtain an API key.
• Follow the rate and usage limits.
• Use HTTPS. HTTP requests are redirected to the corresponding HTTPS resource with status 301.
• On authentication, routing, rate-limit, and unexpected server errors, Hype API returns the corresponding HTTP status and a JSON body like this:

{
  "error": 1,
  "message": "Error description text"
}

Authentication

Hype API authenticates requests using a Bearer token in the Authorization header. Contact Hype support to create an integration between your platform and an existing Hype customer and obtain a token.

Authentication error response

A missing or invalid token returns 401 Unauthorized.

Some endpoints use a different error body. The report endpoints return 403 and 404 errors as {"message": "..."}, and 422 validation errors add an errors object with the failing fields. See each page for its error responses.

Endpoints

DEV: https://es.dev.hype-software.com

LIVE: https://es.hype-software.com

Rate and usage limits

Limits apply per API token and depend on the endpoint group:

Endpoints	Limit
/tasks/* and /webhook/*	1000 requests per minute
/api/*, including report requests, report polling (pollUrl), integrations, and queue jobs	60 requests per minute

Exceeding a limit returns 429 Too Many Requests.

Responses within the limit include these headers:

Header	Description
X-RateLimit-Limit	Maximum number of requests allowed per minute.
X-RateLimit-Remaining	Requests remaining in the current time window.

A 429 response does not include Retry-After or X-RateLimit-Reset. Wait before retrying; the window is one minute.