Cloud

Trello / Reference / REST API

Plugins

Operations

GET/plugins/{id}/PUT/plugins/{id}/POST/plugins/{idPlugin}/listing GET/plugins/{id}/compliance/memberPrivacy PUT/plugins/{idPlugin}/listings/{idListing}

GET

Get a Plugin

Get plugins

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

Responses

Success

application/json

Plugin

GET/plugins/{id}/

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'

200Response

1
2
3

{
  "id": "5abbe4b7ddc1b351ef961414"
}

PUT

Update a Plugin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

Responses

Success

application/json

Plugin

PUT/plugins/{id}/

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'

200Response

1
2
3

{
  "id": "5abbe4b7ddc1b351ef961414"
}

POST

Create a Listing for Plugin

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

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

idPlugin

TrelloID

Required

Request bodyapplication/json

description

string

locale

string

overview

string

name

string

Responses

Success

application/json

PluginListing

POST/plugins/{idPlugin}/listing

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>"
}'

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "name": "Attachment Section Example",
  "locale": "en-US",
  "description": "The [Glitch](https://glitch.com) Power-Up allows you to...",
  "overview": ""
}

GET

Get Plugin's Member privacy compliance

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

TrelloID

Required

Responses

Success

GET/plugins/{id}/compliance/memberPrivacy

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'

PUT

Updating Plugin's Listing

Update an existing listing for your Power-Up

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

idPlugin

TrelloID

Required

idListing

TrelloID

Required

Request bodyapplication/json

description

string

locale

string

overview

string

name

string

Responses

Success

application/json

PluginListing

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

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>"
}'

200Response

{
  "id": "5abbe4b7ddc1b351ef961414",
  "name": "Attachment Section Example",
  "locale": "en-US",
  "description": "The [Glitch](https://glitch.com) Power-Up allows you to...",
  "overview": ""
}