The Trello REST API

Tokens

Get a Token

GET /1/tokens/{token}

Retrieve information about a token.

Request

Path parameters

token Required

string

Query parameters

fields

string

all or a comma-separated list of dateCreated, dateExpires, idMember, identifier, permissions

Valid values: identifier, idMember, dateCreated, dateExpires, permissions

webhooks

boolean

Determines whether to include webhooks.

Default: false

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/tokens/{token}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Token

Get Token's Member

GET /1/tokens/{token}/member

Retrieve information about a token's owner by token.

Request

Path parameters

token Required

string

Query parameters

fields

string

all or a comma-separated list of valid fields for Member Object.

Valid values: id

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/tokens/{token}/member' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Member

Get Webhooks for Token

GET /1/tokens/{token}/webhooks

Retrieve all webhooks created with a Token.

Request

Path parameters

token Required

string

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/tokens/{token}/webhooks' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Webhook>

Create Webhooks for Token

POST /1/tokens/{token}/webhooks

Create a new webhook for a Token.

Request

Path parameters

token Required

string

Query parameters

description

string

A description to be displayed when retrieving information about the webhook.

callbackURL Required

string

The URL that the webhook should POST information to.

Format: url

idModel Required

string

ID of the object to create a webhook on.

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.trello.com/1/tokens/{token}/webhooks?callbackURL={callbackURL}&idModel=5abbe4b7ddc1b351ef961414' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Webhook

Get a Webhook belonging to a Token

GET /1/tokens/{token}/webhooks/{idWebhook}

Retrieve a webhook created with a Token.

Request

Path parameters

token Required

string

idWebhook Required

string

ID of the Webhooks to retrieve.

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/tokens/{token}/webhooks/{idWebhook}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Webhook

Update a Webhook created by Token

PUT /1/tokens/{token}/webhooks/{idWebhook}

Update a Webhook created by Token

Request

Path parameters

token Required

string

idWebhook Required

string

ID of the Webhooks to retrieve.

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

Query parameters

description

string

A description to be displayed when retrieving information about the webhook.

callbackURL

string

The URL that the webhook should POST information to.

Format: url

idModel

string

ID of the object that the webhook is on.

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'https://api.trello.com/1/tokens/{token}/webhooks/{idWebhook}'

Responses

200

Success

A schema has not been defined for this response code.

Delete a Webhook created by Token

DELETE /1/tokens/{token}/webhooks/{idWebhook}

Delete a webhook created with given token.

Request

Path parameters

token Required

string

idWebhook Required

string

ID of the Webhooks to retrieve.

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/tokens/{token}/webhooks/{idWebhook}'

Responses

200

Success

A schema has not been defined for this response code.

Delete a Token

DELETE /1/tokens/{token}/

Delete a token.

Request

Path parameters

token Required

string

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/tokens/{token}/'

Responses

200

Success

A schema has not been defined for this response code.