Skip to main content

Setup

Install​

If you use npm:

npm install height-app-api

If you use yarn:

yarn add height-app-api

If you use pnpm:

pnpm add height-app-api

It's contains type itself, so you don't need to install @types/height-app-api.

Get Secret Key from Height​

You need to get your secret key from Height to use this package.

  1. Go to Height App
  2. Get the secret key in Settings > API' `Settings > API`
  3. Copy the secret key and go to next section

Create Height instance​

To use Height API with this package, you need to create Height instance.

Height instance contains all of the Height APIs.

You can create Height instance with your secret key.

example.ts
import { Height } from 'height-app-api'

const height = new Height({ secretKey: 'secret_yoursecretkey' });

now you can use all of the Height APIs with Height instance like below:

example.ts
height.users.me();
height.lists.all();
height.tasks.create({...});

Check the Use APIs page to know how to use APIs.