The Trello REST API

Members

Get a Member

GET /1/members/{id}

Get a member

Request

Path parameters

id Required

oneOf [string, string]

The ID or username of the member

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

actions

string

See the Actions Nested Resource

boards

string

See the Boards Nested Resource

boardBackgrounds

string

One of: all, custom, default, none, premium

Default: none

Valid values: all, custom, default, none, premium

boardsInvited

string

all or a comma-separated list of: closed, members, open, organization, pinned, public, starred, unpinned

Valid values: closed, members, open, organization, pinned, public, starred, unpinned

boardsInvited_fields

string

all or a comma-separated list of board fields

Style: form

Valid values: id, name, desc, descData, closed, idMemberCreator, idOrganization, pinned, url, shortUrl ...(Show more)

boardStars

boolean

Whether to return the boardStars or not

Default: false

cards

string

See the Cards Nested Resource for additional options

Default: none

customBoardBackgrounds

string

all or none

Default: none

Valid values: all, none

customEmoji

string

all or none

Default: none

Valid values: all, none

customStickers

string

all or none

Default: none

Valid values: all, none

fields

string

all or a comma-separated list of member fields

Valid values: id

notifications

string

See the Notifications Nested Resource

organizations

string

One of: all, members, none, public

Default: none

Valid values: all, members, none, public

organization_fields

string

all or a comma-separated list of organization fields

Valid values: id, name

organization_paid_account

boolean

Default: false

organizationsInvited

string

One of: all, members, none, public

Default: none

Valid values: all, members, none, public

organizationsInvited_fields

string

all or a comma-separated list of organization fields

Valid values: id, name

paid_account

boolean

Default: false

savedSearches

boolean

Default: false

tokens

string

all or none

Default: none

Valid values: all, none

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Member

Update a Member

PUT /1/members/{id}

Update a Member

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

fullName

string

New name for the member. Cannot begin or end with a space.

initials

string

New initials for the member. 1-4 characters long.

Min length: 1, Max length: 4

username

string

New username for the member. At least 3 characters long, only lowercase letters, underscores, and numbers. Must be unique.

bio

string

avatarSource

string

One of: gravatar, none, upload

Valid values: gravatar, none, upload

prefs/colorBlind

boolean

prefs/locale

string

prefs/minutesBetweenSummaries

integer

-1 for disabled, 1, or 60

Format: int32

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.trello.com/1/members/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Member

Get a field on a Member

GET /1/members/{id}/{field}

Get a particular property of a member

Request

Path parameters

id Required

string

The ID or username of the member

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

field Required

string

One of the member fields

Valid values: id

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/{field}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Member

Get a Member's Actions

GET /1/members/{id}/actions

List the actions for a member

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

filter

string

A comma-separated list of action types.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/actions?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Member>

Get Member's custom Board backgrounds

GET /1/members/{id}/boardBackgrounds

Get a member's custom board backgrounds

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

filter

string

One of: all, custom, default, none, premium

Default: all

Valid values: all, custom, default, none, premium

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/boardBackgrounds?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<BoardBackground>

Upload new boardBackground for Member

POST /1/members/{id}/boardBackgrounds

Upload a new boardBackground

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

file Required

string

Format: binary

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.trello.com/1/members/{id}/boardBackgrounds?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&file={file}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<BoardBackground>

Get a boardBackground of a Member

GET /1/members/{id}/boardBackgrounds/{idBackground}

Get a member's board background

Request

Path parameters

id Required

string

The ID or username of the member

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

idBackground Required

string

The ID of the board background

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

fields

string

all or a comma-separated list of: brightness, fullSizeUrl, scaled, tile

Default: all

Valid values: all, brightness, fullSizeUrl, scaled, tile

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/boardBackgrounds/{idBackground}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	BoardBackground

Update a Member's custom Board background

PUT /1/members/{id}/boardBackgrounds/{idBackground}

Update a board background

Request

Path parameters

id Required

string

The ID or username of the member

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

idBackground Required

string

The ID of the board background

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

brightness

string

One of: dark, light, unknown

Valid values: dark, light, unknown

tile

boolean

Whether the background should be tiled

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.trello.com/1/members/{id}/boardBackgrounds/{idBackground}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	BoardBackground

Delete a Member's custom Board background

DELETE /1/members/{id}/boardBackgrounds/{idBackground}

Delete a board background

Request

Path parameters

id Required

string

The ID or username of the member

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

idBackground Required

string

The ID of the board background

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/members/{id}/boardBackgrounds/{idBackground}'

Responses

200

Success

A schema has not been defined for this response code.

Get a Member's boardStars

GET /1/members/{id}/boardStars

List a member's board stars

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/boardStars?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Create Star for Board

POST /1/members/{id}/boardStars

Star a new board on behalf of a Member

Request

Path parameters

id Required

oneOf [string, string]

The ID or username of the member

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

idBoard Required

string

The ID of the board to star

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

pos Required

oneOf [string, number]

The position of the newly starred board. top, bottom, or a positive float.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.trello.com/1/members/{id}/boardStars?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&idBoard=5abbe4b7ddc1b351ef961414&pos={pos}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<BoardStars>

Get a boardStar of Member

GET /1/members/{id}/boardStars/{idStar}

Get a specific boardStar

Request

Path parameters

id Required

string

The ID or username of the member

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

idStar Required

string

The ID of the board star

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/boardStars/{idStar}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	BoardStars

Update the position of a boardStar of Member

PUT /1/members/{id}/boardStars/{idStar}

Update the position of a starred board

Request

Path parameters

id Required

string

The ID or username of the member

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

idStar Required

string

The ID of the board star

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

pos

oneOf [string, number]

New position for the starred board. top, bottom, or a positive float.

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'https://api.trello.com/1/members/{id}/boardStars/{idStar}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.

Delete Star for Board

DELETE /1/members/{id}/boardStars/{idStar}

Unstar a board

Request

Path parameters

id Required

string

The ID or username of the member

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

idStar Required

string

The ID of the board star

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/members/{id}/boardStars/{idStar}'

Responses

200

Success

A schema has not been defined for this response code.

Get Boards that Member belongs to

GET /1/members/{id}/boards

Lists the boards that the user is a member of.

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

filter

string

all or a comma-separated list of: closed, members, open, organization, public, starred

Default: all

Valid values: all, closed, members, open, organization, public, starred

fields

string

all or a comma-separated list of board fields

Valid values: id, name, desc, descData, closed, idMemberCreator, idOrganization, pinned, url, shortUrl ...(Show more)

lists

string

Which lists to include with the boards. One of: all, closed, none, open

Default: none

Valid values: all, closed, none, open

organization

boolean

Whether to include the Organization object with the Boards

Default: false

organization_fields

string

all or a comma-separated list of organization fields

Style: form

Valid values: id, name

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/boards?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Board>

Get Boards the Member has been invited to

GET /1/members/{id}/boardsInvited

Get the boards the member has been invited to

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

fields

string

all or a comma-separated list of board fields

Valid values: id, name, desc, descData, closed, idMemberCreator, idOrganization, pinned, url, shortUrl ...(Show more)

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/boardsInvited?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Board>

Get Cards the Member is on

GET /1/members/{id}/cards

Gets the cards a member is on

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

filter

string

One of: all, closed, none, open, visible

Default: visible

Valid values: all, closed, none, open, visible

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/cards?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Card>

Get a Member's custom Board Backgrounds

GET /1/members/{id}/customBoardBackgrounds

Get a member's custom board backgrounds

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

Success

Content type	Value
application/json	Array<BoardBackground>

Create a new custom Board Background

POST /1/members/{id}/customBoardBackgrounds

Upload a new custom board background

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

file Required

string

Format: binary

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.trello.com/1/members/{id}/customBoardBackgrounds?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&file={file}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	BoardBackground

Get custom Board Background of Member

GET /1/members/{id}/customBoardBackgrounds/{idBackground}

Get a specific custom board background

Request

Path parameters

id Required

oneOf [string, string]

The ID or username of the member

idBackground Required

string

The ID of the custom background

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/customBoardBackgrounds/{idBackground}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	BoardBackground

Update custom Board Background of Member

PUT /1/members/{id}/customBoardBackgrounds/{idBackground}

Update a specific custom board background

Request

Path parameters

id Required

oneOf [string, string]

The ID or username of the member

idBackground Required

string

The ID of the custom background

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

brightness

string

One of: dark, light, unknown

Valid values: dark, light, unknown

tile

boolean

Whether to tile the background

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.trello.com/1/members/{id}/customBoardBackgrounds/{idBackground}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	BoardBackground

Delete custom Board Background of Member

DELETE /1/members/{id}/customBoardBackgrounds/{idBackground}

Delete a specific custom board background

Request

Path parameters

id Required

oneOf [string, string]

The ID or username of the member

idBackground Required

string

The ID of the custom background

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/members/{id}/customBoardBackgrounds/{idBackground}'

Responses

200

Success

A schema has not been defined for this response code.

Get a Member's customEmojis

GET /1/members/{id}/customEmoji

Get a Member's uploaded custom Emojis

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

Success

Content type	Value
application/json	Array<CustomEmoji>

Create custom Emoji for Member

POST /1/members/{id}/customEmoji

Create a new custom Emoji

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

file Required

string

Format: binary

name Required

string

Name for the emoji. 2 - 64 characters

Min length: 2, Max length: 64

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.trello.com/1/members/{id}/customEmoji?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&file={file}&name={name}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	CustomEmoji

Get a Member's custom Emoji

GET /1/members/{id}/customEmoji/{idEmoji}

Get a Member's custom Emoji

Request

Path parameters

id Required

string

The ID or username of the member

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

idEmoji Required

string

The ID of the custom emoji

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

fields

string

all or a comma-separated list of name, url

Style: form, Default: all

Valid values: name, url, all

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/customEmoji/{idEmoji}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	CustomEmoji

Get Member's custom Stickers

GET /1/members/{id}/customStickers

Get a Member's uploaded stickers

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

Success

Content type	Value
application/json	Array<CustomSticker>

Create custom Sticker for Member

POST /1/members/{id}/customStickers

Upload a new custom sticker

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

file Required

string

Format: binary

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.trello.com/1/members/{id}/customStickers?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&file={file}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	CustomSticker

Get a Member's custom Sticker

GET /1/members/{id}/customStickers/{idSticker}

Get a Member's custom Sticker

Request

Path parameters

id Required

string

The ID or username of the member

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

idSticker Required

string

The ID of the uploaded sticker

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

fields

string

all or a comma-separated list of scaled, url

Style: form, Default: all

Valid values: scaled, url, all

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/customStickers/{idSticker}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	CustomSticker

Delete a Member's custom Sticker

DELETE /1/members/{id}/customStickers/{idSticker}

Delete a Member's custom Sticker

Request

Path parameters

id Required

string

The ID or username of the member

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

idSticker Required

string

The ID of the uploaded sticker

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/members/{id}/customStickers/{idSticker}'

Responses

200

Success

A schema has not been defined for this response code.

Get Member's Notifications

GET /1/members/{id}/notifications

Get a member's notifications

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

entities

boolean

Default: false

display

boolean

Default: false

filter

string

Default: all

read_filter

string

One of: all, read, unread

Default: all

fields

string

all or a comma-separated list of notification fields

Default: all

limit

integer

Max 1000

Default: 50, Format: int32

page

integer

Max 100

Default: 0, Format: int32

before

string

A notification ID

since

string

A notification ID

memberCreator

boolean

Default: true

memberCreator_fields

string

all or a comma-separated list of member fields

Default: avatarHash,fullName,initials,username

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/notifications?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Notification>

Get Member's Organizations

GET /1/members/{id}/organizations

Get a member's teams

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

filter

string

One of: all, members, none, public (Note: members filters to only private teams)

Default: all

Valid values: all, members, none, public

fields

string

all or a comma-separated list of organization fields

Style: form

Valid values: id, name

paid_account

boolean

Default: false

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/organizations?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Organization>

Get Organizations a Member has been invited to

GET /1/members/{id}/organizationsInvited

Get a member's teams they have been invited to

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

fields

string

all or a comma-separated list of organization fields

Valid values: id, name

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/organizationsInvited?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Organization>

Get Member's saved searched

GET /1/members/{id}/savedSearches

List the saved searches of a Member

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

Success

Content type	Value
application/json	Array<SavedSearch>

Create saved Search for Memer

POST /1/members/{id}/savedSearches

Create a saved search

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

name Required

string

The name for the saved search

query Required

string

The search query

pos Required

oneOf [string, number]

The position of the saved search. top, bottom, or a positive float.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.trello.com/1/members/{id}/savedSearches?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&name={name}&query={query}&pos={pos}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	SavedSearch

Get a saved search

GET /1/members/{id}/savedSearches/{idSearch}

Get a saved search

Request

Path parameters

id Required

string

The ID or username of the member

idSearch Required

string

The ID of the saved search to delete

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/members/{id}/savedSearches/{idSearch}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	SavedSearch

Update a saved search

PUT /1/members/{id}/savedSearches/{idSearch}

Update a saved search

Request

Path parameters

id Required

string

The ID or username of the member

idSearch Required

string

The ID of the saved search to delete

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

name

string

The new name for the saved search

query

string

The new search query

pos

string

New position for saves search. top, bottom, or a positive float.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.trello.com/1/members/{id}/savedSearches/{idSearch}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	SavedSearch

Delete a saved search

DELETE /1/members/{id}/savedSearches/{idSearch}

Delete a saved search

Request

Path parameters

id Required

string

The ID or username of the member

idSearch Required

string

The ID of the saved search to delete

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/members/{id}/savedSearches/{idSearch}'

Responses

200

Success

A schema has not been defined for this response code.

Get Member's Tokens

GET /1/members/{id}/tokens

List a members app tokens

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

webhooks

boolean

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/members/{id}/tokens?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Array<Token>

Create Avatar for Member

POST /1/members/{id}/avatar

Create a new avatar for a member

Request

Path parameters

id Required

string

The ID or username of the member

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

file Required

string

Format: binary

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'https://api.trello.com/1/members/{id}/avatar?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&file={file}'

Responses

200

Success

A schema has not been defined for this response code.

Dismiss a message for Member

POST /1/members/{id}/oneTimeMessagesDismissed

Dismiss a message

Request

Path parameters

id Required

string

The ID or username of the member

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

Query parameters

key Required

string

The API key to use

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

token Required

string

The API token to use

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

value Required

string

The message to dismiss

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

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'https://api.trello.com/1/members/{id}/oneTimeMessagesDismissed?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value=5abbe4b7ddc1b351ef961414'

Responses

200

Success

A schema has not been defined for this response code.

Trello Developer

Trello Developer

Members

Get a Member

Request

Path parameters

Query parameters

Example

Responses

Update a Member

Request

Path parameters

Query parameters

Example

Responses

Get a field on a Member

Request

Path parameters

Query parameters

Example

Responses

Get a Member's Actions

Request

Path parameters

Query parameters

Example

Responses

Get Member's custom Board backgrounds

Request

Path parameters

Query parameters

Example

Responses

Upload new boardBackground for Member

Request

Path parameters

Query parameters

Example

Responses

Get a boardBackground of a Member

Request

Path parameters

Query parameters

Example

Responses

Update a Member's custom Board background

Request

Path parameters

Query parameters

Example

Responses

Delete a Member's custom Board background

Request

Path parameters

Query parameters

Example

Responses

Get a Member's boardStars

Request

Path parameters

Query parameters

Example

Responses

Create Star for Board

Request

Path parameters

Query parameters

Example

Responses

Get a boardStar of Member

Request

Path parameters

Query parameters

Example

Responses

Update the position of a boardStar of Member

Request

Path parameters

Query parameters

Example