Skip to main content

Use API

::: note

You need to create Height instance to use APIs.

Read Setup page to know how to create Height instance.

:::

How to use APIs​

All apis in OpenAPI Specification are implemented in this package.

image

When you are using API in TypeScript, just remember the following rules:

  1. Path parameters in OpenAPI Specification is combined to request body in this package. ex: /tasks/:id->height.tasks.get({ id: '...' })`
  2. Query parameters of GET requests in OpenAPI Specification is combined to request body in this package. ex: /activities?taskId=...->height.activities.get({ taskId: '...' })`
  3. Query parameters of other requests in OpenAPI Specification is combined to request body with queryParams property ex: /tasks/:id/?filters=...->height.tasks.update({ id: '...', queryParams: { filters: {...} } })`