Getting Started with Trello

Introduction

This document describes the REST API of Trello as published by Trello.com.

• Official Documentation
• The HTML pages that were scraped in order to generate this specification.

Find out more here: https://developers.trello.com

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | apiKeyCredentials | ApiKeyCredentials | The credential object for apiKey | | apiTokenCredentials | ApiTokenCredentials | The credential object for apiToken |

The API client can be initialized as follows:

import { Client } from 'trello-sdk';

const client = new Client({
  apiKeyCredentials: {
    'key': 'key'
  },
  apiTokenCredentials: {
    'token': 'token'
  },
  timeout: 0,
});

Authorization

This API uses the following authentication schemes.

• api_key (Custom Query Parameter)
• api_token (Custom Query Parameter)

List of APIs

• Action
• Batch
• Board
• Card
• Checklist
• Label
• List
• Member
• Notification
• Organization
• Search
• Session
• Token
• Type
• Webhook

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError