The Trello REST API

Plugins

Get a Plugin

GET /1/plugins/{id}/

Get plugins

Request

Path parameters

id Required

string

The ID or name of the organization

Pattern: ^[0-9a-fA-F]{24}$

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/plugins/{id}/?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Plugin

Update a Plugin

PUT /1/plugins/{id}/

Update a Plugin

Request

Path parameters

id Required

string

The ID or name of the organization

Pattern: ^[0-9a-fA-F]{24}$

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.trello.com/1/plugins/{id}/?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Plugin

Create a Listing for Plugin

POST /1/plugins/{idPlugin}/listing

Create a new listing for a given locale for your Power-Up

Request

Path parameters

idPlugin Required

string

The ID of the Power-Up for which you are creating a new listing.

Pattern: ^[0-9a-fA-F]{24}$

Body parameters

description

string

The description to show for the given locale

locale

string

The locale that this listing should be displayed for.

overview

string

The overview to show for the given locale.

name

string

The name to use for the given locale.

Example

cURL

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.trello.com/1/plugins/{idPlugin}/listing?key=APIKey&token=APIToken' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "locale": "<string>",
  "overview": "<string>",
  "name": "<string>"
}'

Responses

200

Success

Content type	Value
application/json	PluginListing

Get Plugin's Member privacy compliance

GET /1/plugins/{id}/compliance/memberPrivacy

Request

Path parameters

id Required

string

The ID of the Power-Up

Pattern: ^[0-9a-fA-F]{24}$

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/plugins/{id}/compliance/memberPrivacy?key=APIKey&token=APIToken'

Responses

200

Success

A schema has not been defined for this response code.

Updating Plugin's Listing

PUT /1/plugins/{idPlugin}/listings/{idListing}

Update an existing listing for your Power-Up

Request

Path parameters

idPlugin Required

string

The ID of the Power-Up whose listing is being updated.

Pattern: ^[0-9a-fA-F]{24}$

idListing Required

string

The ID of the existing listing for the Power-Up that is being updated.

Pattern: ^[0-9a-fA-F]{24}$

Body parameters

description

string

The description to show for the given locale

locale

string

The locale that this listing should be displayed for.

overview

string

The overview to show for the given locale.

name

string

The name to use for the given locale.

Example

cURL

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.trello.com/1/plugins/{idPlugin}/listings/{idListing}?key=APIKey&token=APIToken' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "locale": "<string>",
  "overview": "<string>",
  "name": "<string>"
}'

Responses

200

Success

Content type	Value
application/json	PluginListing