Trello.js - API library
    Preparing search index...

    Interface GetSearch

    interface GetSearch {
        board?: {
            fields?:
                | string
                | string[]
                | (
                    | "name"
                    | "url"
                    | "closed"
                    | "desc"
                    | "dateLastActivity"
                    | "descData"
                    | "shortLink"
                    | "shortUrl"
                    | "subscribed"
                    | "dateLastView"
                    | "idOrganization"
                    | "invitations"
                    | "invited"
                    | "labelNames"
                    | "memberships"
                    | "pinned"
                    | "powerUps"
                    | "prefs"
                    | "starred"
                )[];
            organization?: string;
        };
        boardFields?: string[]
        | "all";
        boards?: { limit?: number };
        boardsLimit?: number;
        card?: {
            attachments?: boolean;
            board?: boolean;
            fields?:
                | string
                | string[]
                | (
                    | "name"
                    | "url"
                    | "closed"
                    | "desc"
                    | "email"
                    | "labels"
                    | "badges"
                    | "checkItemStates"
                    | "dateLastActivity"
                    | "descData"
                    | "due"
                    | "idAttachmentCover"
                    | "idBoard"
                    | "idChecklists"
                    | "idLabels"
                    | "idList"
                    | "idMembers"
                    | "idMembersVoted"
                    | "idShort"
                    | "manualCoverAttachment"
                    | "pos"
                    | "shortLink"
                    | "shortUrl"
                    | "subscribed"
                )[];
            list?: boolean;
            members?: boolean;
            stickers?: boolean;
        };
        cardAttachments?: string
        | boolean;
        cardBoard?: boolean;
        cardFields?: string[] | "all";
        cardList?: boolean;
        cardMembers?: boolean;
        cards?: { limit?: number; page?: number };
        cardsLimit?: number;
        cardsPage?: number;
        cardStickers?: boolean;
        idBoards?: string[] | "mine";
        idCards?: string[];
        idOrganizations?: string[];
        member?: { fields?: string };
        memberFields?: string;
        members?: { limit?: number };
        membersLimit?: number;
        modelTypes?:
            | string
            | string[]
            | ("members" | "actions" | "boards" | "cards" | "organizations")[];
        organization?: { fields?: string | string[] };
        organizationFields?: string;
        organizations?: { limit?: number };
        organizationsLimit?: number;
        partial?: boolean;
        query: string;
    }
    Index

    Properties

    board? boardFields? boards? boardsLimit? card? cardAttachments? cardBoard? cardFields? cardList? cardMembers? cards? cardsLimit? cardsPage? cardStickers? idBoards? idCards? idOrganizations? member? memberFields? members? membersLimit? modelTypes? organization? organizationFields? organizations? organizationsLimit? partial? query

    Properties

    board?: {
        fields?:
            | string
            | string[]
            | (
                | "name"
                | "url"
                | "closed"
                | "desc"
                | "dateLastActivity"
                | "descData"
                | "shortLink"
                | "shortUrl"
                | "subscribed"
                | "dateLastView"
                | "idOrganization"
                | "invitations"
                | "invited"
                | "labelNames"
                | "memberships"
                | "pinned"
                | "powerUps"
                | "prefs"
                | "starred"
            )[];
        organization?: string;
    }

    Type declaration

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

      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

    • Optionalorganization?: string
    boardFields?: string[] | "all"

    Use board: { fields: '...' } instead.

    boards?: { limit?: number }

    Type declaration

    • Optionallimit?: number

      The maximum number of boards returned. Maximum: 1000

    boardsLimit?: number

    Use boards: { limit: 1 } instead.

    The maximum number of boards returned. Maximum: 1000

    card?: {
        attachments?: boolean;
        board?: boolean;
        fields?:
            | string
            | string[]
            | (
                | "name"
                | "url"
                | "closed"
                | "desc"
                | "email"
                | "labels"
                | "badges"
                | "checkItemStates"
                | "dateLastActivity"
                | "descData"
                | "due"
                | "idAttachmentCover"
                | "idBoard"
                | "idChecklists"
                | "idLabels"
                | "idList"
                | "idMembers"
                | "idMembersVoted"
                | "idShort"
                | "manualCoverAttachment"
                | "pos"
                | "shortLink"
                | "shortUrl"
                | "subscribed"
            )[];
        list?: boolean;
        members?: boolean;
        stickers?: boolean;
    }

    Type declaration

    • Optionalattachments?: boolean

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

    • Optionalboard?: boolean

      Whether to include the parent board with card results

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

      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

    • Optionallist?: boolean

      Whether to include the parent list with card results

    • Optionalmembers?: boolean

      Whether to include member objects with card results

    • Optionalstickers?: boolean

      Whether to include sticker objects with card results

    cardAttachments?: string | boolean

    Use card: { attachments: true } instead.

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

    cardBoard?: boolean

    Use card: { board: true } instead.

    Whether to include the parent board with card results

    cardFields?: string[] | "all"

    Use card: { fields: '...' } instead.

    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

    cardList?: boolean

    Use card: { list: true } instead.

    Whether to include the parent list with card results

    cardMembers?: boolean

    Use card: { members: true } instead.

    Whether to include member objects with card results

    cards?: { limit?: number; page?: number }

    Type declaration

    • Optionallimit?: number

      The maximum number of cards to return. Maximum: 1000

    • Optionalpage?: number

      The page of results for cards. Maximum: 100

    cardsLimit?: number

    Use cards: { limit: 1 } instead.

    The maximum number of cards to return. Maximum: 1000

    cardsPage?: number

    Use cards: { page: 1 } instead.

    The page of results for cards. Maximum: 100

    cardStickers?: boolean

    Use card: { stickers: true } instead.

    Whether to include sticker objects with card results

    idBoards?: string[] | "mine"

    mine or a comma-separated list of Board IDs

    idCards?: string[]

    A comma-separated list of Card IDs

    idOrganizations?: string[]

    A comma-separated list of Organization IDs

    member?: { fields?: string }

    Type declaration

    • Optionalfields?: string

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

    memberFields?: string

    Use member: { fields: '...' } instead.

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

    members?: { limit?: number }

    Type declaration

    • Optionallimit?: number

      The maximum number of members to return. Maximum 1000

    membersLimit?: number

    Use members: { limit: 1 } instead.

    The maximum number of members to return. Maximum 1000

    modelTypes?:
        | string
        | string[]
        | ("members" | "actions" | "boards" | "cards" | "organizations")[]

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

    organization?: { fields?: string | string[] }

    Type declaration

    • Optionalfields?: string | string[]

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

    organizationFields?: string

    Use organization: { fields: '...' } instead.

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

    organizations?: { limit?: number }

    Type declaration

    • Optionallimit?: number

      The maximum number of teams to return. Maximum 1000

    organizationsLimit?: number

    Use organizations: { limit: 1 } instead.

    The maximum number of teams to return. Maximum 1000

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

    query: string

    The search query with a length of 1 to 16384 characters

    Settings

    Member Visibility

    On This Page

    Properties