@shortcut/client

A library for interacting with the Shortcut REST API.

Getting Started

Installation

You can install @shortcut/client with NPM or Yarn.

npm install --save @shortcut/client
Copy

or

yarn add @shortcut/client
Copy

Our legacy organization name is @useshortcut. While this will still contain copies of all future released package versions, we strongly recommended switching to our primary @shortcut organization namespace.

How to Get an API Token

The Shortcut API uses token-based authentication, you will need one to use this library.

To generate an API token, go to https://app.shortcut.com/settings/account/api-tokens. To make it easier to explore our API, we recommend saving this token as an environment variable in your local dev environment:

export SHORTCUT_API_TOKEN="YOUR API TOKEN HERE"
Copy

This will allow you to copy and paste many examples in the documentation to try them out.

Requests made with a missing or invalid token will get a 401 Unauthorized response. All requests must be made over HTTPS. Tokens provide complete access to your Shortcut account, so keep them secure. Don’t paste them into your source code, use an environment variable instead. For security reasons, we will immediately invalidate any tokens we find have been made public.

Usage

To see all available exports, take a look at the API documentation or check out the .d.ts files in this repository.

import { ShortcutClient } from '@shortcut/client';
// const { ShortcutClient } = require('@shortcut/client');

const shortcut = new ShortcutClient('YOUR_API_TOKEN'); // See https://github.com/useshortcut/shortcut-client-js#how-to-get-an-api-token

shortcut.getCurrentMemberInfo().then((response) => console.log(response?.data));

shortcut.listProjects().then((response) => console.log(response?.data));
Copy

Play with It

You can play with it in your web browser with this live playground:

• CodeSandbox

Documentation

Documentation for this client.

Documentation for the REST API.