Type Alias: Search

type Search = object;

Defined in: parameters/search.ts:256

Type Declaration

boardFields?

optional boardFields?: 
  | "name"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "shortLink"
  | "prefs"
  | "invitations"
  | "dateLastActivity"
  | "memberships"
  | "descData"
  | "powerUps"
  | "invited"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "subscribed"
  | "dateLastView"
  | (
  | "name"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "shortLink"
  | "prefs"
  | "invitations"
  | "dateLastActivity"
  | "memberships"
  | "descData"
  | "powerUps"
  | "invited"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "subscribed"
  | "dateLastView")[];

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

boardOrganization?

optional boardOrganization?: boolean;

Whether to include the parent organization with board results

boardsLimit?

optional boardsLimit?: number;

The maximum number of boards returned. Maximum: 1000

cardAttachments?

optional cardAttachments?: string;

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

cardBoard?

optional cardBoard?: boolean;

Whether to include the parent board with card results

cardFields?

optional cardFields?: 
  | "name"
  | "url"
  | "closed"
  | "desc"
  | "labels"
  | string & object
  | "idShort"
  | "shortLink"
  | "idList"
  | "idLabels"
  | "pos"
  | "due"
  | "dateLastActivity"
  | "descData"
  | "shortUrl"
  | "subscribed"
  | "idBoard"
  | "badges"
  | "checkItemStates"
  | "idChecklists"
  | "idMembers"
  | "idMembersVoted"
  | "idAttachmentCover"
  | "manualCoverAttachment"
  | (
  | "name"
  | "url"
  | "closed"
  | "desc"
  | "labels"
  | string & object
  | "idShort"
  | "shortLink"
  | "idList"
  | "idLabels"
  | "pos"
  | "due"
  | "dateLastActivity"
  | "descData"
  | "shortUrl"
  | "subscribed"
  | "idBoard"
  | "badges"
  | "checkItemStates"
  | "idChecklists"
  | "idMembers"
  | "idMembersVoted"
  | "idAttachmentCover"
  | "manualCoverAttachment")[];

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

cardList?

optional cardList?: boolean;

Whether to include the parent list with card results

cardMembers?

optional cardMembers?: boolean;

Whether to include member objects with card results

cardsLimit?

optional cardsLimit?: number;

The maximum number of cards to return. Maximum: 1000

cardsPage?

optional cardsPage?: number;

The page of results for cards. Maximum: 100

cardStickers?

optional cardStickers?: boolean;

Whether to include sticker objects with card results

idBoards?

optional idBoards?: string & object | "mine";

mine or a comma-separated list of Board IDs

idCards?

optional idCards?: string | string[];

A comma-separated list of Card IDs

idOrganizations?

optional idOrganizations?: string | string[];

A comma-separated list of Organization IDs

memberFields?

optional memberFields?: 
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "avatarHash"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "products"
  | (
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "avatarHash"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "products")[];

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

membersLimit?

optional membersLimit?: number;

The maximum number of members to return. Maximum 1000

modelTypes?

optional modelTypes?: 
  | string & object
  | "boards"
  | "cards"
  | "organizations"
  | "members"
  | "actions"
  | (
  | string & object
  | "boards"
  | "cards"
  | "organizations"
  | "members"
  | "actions")[];

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

organizationFields?

optional organizationFields?: 
  | "name"
  | "url"
  | "desc"
  | string & object
  | "prefs"
  | "products"
  | "idBoards"
  | "premiumFeatures"
  | "displayName"
  | "invitations"
  | "memberships"
  | "descData"
  | "logoHash"
  | "powerUps"
  | "website"
  | "billableMemberCount"
  | "invited"
  | (
  | "name"
  | "url"
  | "desc"
  | string & object
  | "prefs"
  | "products"
  | "idBoards"
  | "premiumFeatures"
  | "displayName"
  | "invitations"
  | "memberships"
  | "descData"
  | "logoHash"
  | "powerUps"
  | "website"
  | "billableMemberCount"
  | "invited")[];

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

organizationsLimit?

optional organizationsLimit?: number;

The maximum number of Workspaces to return. Maximum 1000

partial?

optional 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".

query

query: string;

The search query with a length of 1 to 16384 characters