atlassian-ts

A type-safe Typescript client for the Atlassian REST API, powered by openapi-fetch and ky.

Features

• Full TypeScript support for Atlassian REST API endpoints
• OAuth 2.0 and Basic Authentication support
• Automatic retries with configurable limits
• Built on top of robust libraries: openapi-fetch and ky

Installation

1pnpm add atlassian-ts

Usage

You can create a client for either OAuth 2.0 or Basic Authentication.

OAuth 2.0 Client

For integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security (3LO scopes are shown as for operations OAuth scopes required). Read more here.

1import { createOauth2Client } from 'atlassian-ts';
2
3const client = createOauth2Client({
4  cloudId: 'your-cloud-id',
5  accessToken: 'your-access-token',
6  retries: 3,
7});
8
9const projects = await client.GET('/rest/api/3/project');

Basic Authentication Client

For personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. Read more here.

1import { createBasicAuthClient } from 'atlassian-ts';
2
3const client = createBasicAuthClient({
4  siteUrl: 'https://your-site.atlassian.net',
5  email: 'your-email@example.com',
6  apiToken: 'your-api-token',
7  retries: 3,
8});
9
10const projects = await client.GET('/rest/api/3/project');