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 Tasks API

The Tasks API from Height — 3 operation(s) for tasks.

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

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

This API exposes 6 operations across 3 paths, and defines 17 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.

6 operations 3 paths 17 schemas 2 GET2 PATCH1 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 Tasks 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 6

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

Tasks 6
POST
/tasks
Create a task
createTask 2 params body → 201
PATCH
/tasks
Patch multiples tasks
patchTasks body → 200
GET
/tasks
Search tasks
searchTasks 1 param → 200
GET
/tasks/:id
Get a task
getTask 2 params → 200
PATCH
/tasks/:id
Update a single task
updateTask 1 param body → 200
PUT
/tasks/move
Move tasks
moveTasks body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are TaskObject (21 properties), CreateTaskRequest (8 properties), UpdateTaskRequest (7 properties), PatchTasksFieldsEffect (4 properties). Each schema is shown below with its type and property counts.

CreateTaskRequest
object
8 properties 2 required
PatchTasksRequest
object
Patch multiples tasks
1 property
PatchTasksListsEffect
object
Update lists
2 properties
MoveTasksRequest
object
3 properties 3 required
UpdateTaskRequest
object
7 properties 1 required
TaskObject
object
21 properties 20 required
PatchTasksMoveToTrashEffect
object
Move trash to the task
3 properties 3 required
PatchTasksParentTaskEffect
object
Update parent task
2 properties 1 required
PatchTasksStatusEffect
object
Update status
3 properties 2 required
PatchTasksAssigneesEffect
object
Update assignees
2 properties 2 required
PatchTasksOutOfTrashEffect
object
Move task out of the trash
3 properties 3 required
PatchTasksResponse
object
1 property
SearchTasksResponse
object
1 property
PatchTasksDeletedEffect
object
Update deleted
2 properties 2 required
PatchTasksDescriptionEffect
object
Update description
2 properties 2 required
PatchTasksFieldsEffect
object
Update fields
4 properties 3 required
PatchTasksNameEffect
object
Update name
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

height-tasks-api-openapi.yml Raw ↑

Other APIs Height publishes across the network.

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