/boards

Query Parameters

name

• Type: string
• Description: Free text board name search filter

limit

• Type: string
• Description: Limits the number of boards items to return in the response

cursor

• Type: string
• Description: Cursor returned in the previous page of responses used to get the next page of results

parentBoardId

• Type: string
• Description: Used when navigating immediate child sub boards in a board hierarchy

customField

• Type: string
• Description: For single- and multi-select custom fields, filter for entities matching specific values. This query parameter can be supplied multiple times, as custom field ID UUID and custom field value ID UUID pairs, separated by a colon :, e.g. &customField=fb9e852c-eb2a-4dd0-81f4-7af266c335d1:7b6e39bb-28bb-46ae-be8a-5c01bbacf78c. Supplying multiple custom field UUID's matches all (AND), and multiple custom field value UUID's per the same repeated custom field matches any (OR).

libraryId

• Type: string
• Description: Only return boards in this library. Cannot be combined with inGeneralLibrary=true; supplying both returns a 400.

inGeneralLibrary

• Type: boolean
• Description: Set to true to return only boards in the General library (boards not in any real library). When true, cannot be combined with libraryId; supplying both returns a 400.

Example Request

curl --request GET \
     --url https://api.air.inc/v1/boards \
     --header 'accept: application/json'

Notes

• default: Default
• Updated: 4 months ago

Did this page help you?

• Yes
• No