Quick start

Install the client and make your first request.

Install the client

pnpm add redmine-api-client

The package is ESM only and works in Node.js and in browsers.

Create a client

redmine.ts

import { RedmineClient } from "redmine-api-client";

export const client = new RedmineClient("https://redmine.example.com", {
  key: process.env.REDMINE_API_KEY!,
});

See Authentication for where to find the API key.

Call the API

import { IssueQueryInclude } from "redmine-api-client";

const { issue } = await client.issuesClient.getIssue(42, {
  include: [IssueQueryInclude.Journals],
});

console.log(issue.subject, issue.createdOn);

The clients page shows what else the client can do.

Using React?

See React for queries and hooks for TanStack Query.

Introduction

A typed, tested description of the Redmine REST API, with a TypeScript client.

Authentication

Authenticate requests with a Redmine API key.

On this page

Install the client Create a client Call the API Using React?