GET /boards/{id}

Request a single board.

Servers

Path parameters

Name Type Required Description
id String Yes

Query parameters

Name Type Required Description
members String No

This is a nested resource. Read more about members as nested resources here.

Default value: "none"

organization_pluginData Boolean No

Use with the organization param to include organization pluginData with the response

Default value: false

memberships String No

This is a nested resource. Read more about memberships as nested resources here.

Default value: "none"

labels String No

This is a nested resource. Read more about labels as nested resources here.

card_pluginData Boolean No

Use with the cards param to include card pluginData with the response

Default value: false

myPrefs Boolean No

Default value: false

lists String No

This is a nested resource. Read more about lists as nested resources here.

Default value: "open"

fields String No

The fields of the board to be included in the response. Valid values: all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idMemberCreator, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url

Default value: "name,desc,descData,closed,idOrganization,pinned,url,shortUrl,prefs,labelNames"

organization Boolean No

This is a nested resource. Read more about organizations as nested resources here.

Default value: false

checklists String No

This is a nested resource. Read more about checklists as nested resources here.

Default value: "none"

actions String No

This is a nested resource. Read more about actions as nested resources here.

Default value: "all"

customFields Boolean No

This is a nested resource. Read more about custom fields as nested resources here.

Default value: false

pluginData Boolean No

Determines whether the pluginData for this board should be returned. Valid values: true or false.

Default value: false

cards String No

This is a nested resource. Read more about cards as nested resources here.

Default value: "none"

tags Boolean No

Also known as collections, tags, refer to the collection(s) that a Board belongs to.

Default value: false

boardStars String No

Valid values are one of: mine or none.

Default value: "none"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.