Socket
Book a DemoInstallSign in
Socket

@shortcut/client

Package Overview
Dependencies
Maintainers
2
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@shortcut/client

A library for interacting with the Shortcut REST API

2.3.1
latest
Source
npmnpm
Version published
Maintainers
2
Created
Source

@shortcut/client

Shortcut's logo

Version Monthly Downloads GitHub License PRs welcome! X

A library for interacting with the Shortcut REST API.


Getting Started

Installation

npm install @shortcut/client

[!IMPORTANT] Our legacy npm organization namespace is @useshortcut.

While it will still contain copies of all future released package versions, we strongly recommend 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"

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

[!NOTE] Requests made with a missing or invalid token will get a 401 Unauthorized response.

[!NOTE] All requests must be made over HTTPS.

[!CAUTION] 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));

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.

FAQs

Package last updated on 21 Aug 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.