/boards

get

https://api.air.inc/v1/boards

Get the list of boards defined in an Air workspace. Sorted by updatedAt descending (most recently updated board first).

Query Params

name

string

Free text board name search filter

limit

string

Limits the number of boards items to return in the response

cursor

string

Cursor returned in the previous page of responses used to get the next page of results

parentBoardId

string

Used when navigating immediate child sub boards in a board hierarchy

customField

string

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 mutliple custom field value UUID's per the same repeated custom field matches any (OR).

libraryId

string

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

inGeneralLibrary

boolean

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.

Response

defaultDefault