Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Height Lists API

Tasks belong to one list. To create tasks, it's necessary to know in which list you want to create them.

Height Lists API is one of 9 APIs that Height publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Lists. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.height.app.

3 operations 2 paths 7 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.height.app
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Height Lists API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — The Height API uses API keys to authenticate requests. You can view your API key in the Height settings under API. ex: api-key secret1234

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Lists 3

Tasks belong to one list. To create tasks, it's necessary to know in which list you want to create them.

POST
/lists
Create a list
createList body → 200
GET
/lists
List all lists
listAllLists → 200
PUT
/lists/{id}
Update a list
updateList 1 param body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ListObject (7 properties), CreateSmartListRequest (6 properties), CreateNormalListRequest (5 properties), UpdateListRequest (5 properties). Each schema is shown below with its type and property counts.

ListObject
object
Tasks belong to one list. To create tasks, it's necessary to know in which list you want to create them.
7 properties 7 required
UpdateListRequest
object
5 properties
FiltersObject
object
See FiltersObject.ts
CreateListRequest
CreateNormalListRequest
object
Create a list
5 properties 2 required
ListAllResponse
object
1 property 1 required
CreateSmartListRequest
object
Create a smartlist
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

height-lists-api-openapi.yml Raw ↑

Other APIs Height publishes across the network.

Height Activities API
Height Field Templates API
Height Groups API
Height Security Log Events API
Height Task Forms API
Height Tasks API
Height Users API
Height Workspace API