Rate this page:

Search Trello

GET /1/search

Find what you're looking for in Trello

Request

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}$
query Required

string

The search query with a length of 1 to 16384 characters

Min length: 1, Max length: 16834
idBoards

oneOf [string, string]

mine or a comma-separated list of Board IDs

Style: form
idOrganizations

string

A comma-separated list of Organization IDs

Style: form
idCards

string

A comma-separated list of Card IDs

Style: form
modelTypes

string

What type or types of Trello objects you want to search. all or a comma-separated list of: actions, boards, cards, members, organizations

Default: all
board_fields

string

all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url

Style: form, Default: name,idOrganization
boards_limit

integer

The maximum number of boards returned. Maximum: 1000

Default: 10, Maximum: 1000
card_fields

string

all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed, url

Style: form, Default: all
cards_limit

integer

The maximum number of cards to return. Maximum: 1000

Style: form, Default: 10, Maximum: 1000
cards_page

number

The page of results for cards. Maximum: 100

Default: 0, Maximum: 100
card_board

boolean

Whether to include the parent board with card results

Default: false
card_list

boolean

Whether to include the parent list with card results

Default: false
card_members

boolean

Whether to include member objects with card results

Default: false
card_stickers

boolean

Whether to include sticker objects with card results

Default: false
card_attachments

string

Whether to include attachment objects with card results. A boolean value (true or false) or cover for only card cover attachments.

Default: false
organization_fields

string

all or a comma-separated list of billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url, website

Default: name,displayName
organizations_limit

integer

The maximum number of teams to return. Maximum 1000

Default: 10, Format: int32
member_fields

string

all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username

Default: avatarHash,fullName,initials,username,confirmed
members_limit

integer

The maximum number of members to return. Maximum 1000

Default: 10, Format: int32
partial

boolean

By default, Trello searches for each word in your query against exactly matching words within Member content. Specifying partial to be true means that we will look for content that starts with any of the words in your query. If you are looking for a Card titled "My Development Status Report", by default you would need to search for "Development". If you have partial enabled, you will be able to search for "dev" but not "velopment".

Default: false

Example

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

Responses

Success

Content typeValue
application/json

Array<oneOf [Member, Card, Board, Organization]>

Search for Members

GET /1/search/members/

Search for Trello members.

Request

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}$
query Required

string

Search query 1 to 16384 characters long

Min length: 1, Max length: 16394
limit

integer

The maximum number of results to return. Maximum of 20.

Default: 8, Maximum: 20, Format: int32
idBoard

string

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

string

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

boolean

Default: false

Example

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

Responses

Success

Content typeValue
application/json

Array<Member>

Rate this page: