The Height API is a REST API accessible through HTTPs. All endpoints return JSON-encoded responses and uses standard HTTP response codes and verbs.

Authentication

The Height API uses API keys to authenticate requests. You can view your API key in the Height settings under API.

Authentication to the API is performed via the Authorization header. All API requests should be made over HTTPs.

i.e. Get your workspace.

curl <https://api.height.app/workspace> \\
  -H "Authorization: api-key secret_1234" 

Object formats

All objects have a unique id (UUID v4) and a model attribute to distinguish the model type.

e.g. a task object.

{
	"id": "123e4567-e89b-12d3-a456-426655440000",
  "model": "task",
	"name": "Fix bug",
  "index": 1,
  "status": "backLog",
	[...]
}

Date formats

Every date uses the ISO format e.g.

"2019-11-07T17:00:00.000Z"

Real-time

Any change that you make to the API will be pushed to every user in real-time: i.e. creating tasks or messages.

Rate limits

To keep incoming traffic under control and maintain a great experience for all our users, our API is behind a rate limiter. Users who send many requests in quick succession may see error responses that show up as status code 429.

Height allows up to 120 requests/min, but we have stricter limits on these endpoints: