AIair
Boards

/boards

Changed on

Get the list of boards defined in an Air workspace.

Sorted by updatedAt descending (most recently updated board first).

get/v1/boards

Request

  • Base URL
    api.air.inc (relative, and the document’s source URL is not known)
  • Auth
    • API key in header x-api-key and API key in header x-air-workspace-id
    • or HTTP bearer and API key in header x-air-workspace-id
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

namestring

Free text board name search filter

limitstring

Limits the number of boards items to return in the response

cursorstring

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

parentBoardIdstring

Used when navigating immediate child sub boards in a board hierarchy

showcaseIdstring

Only return boards added to this showcase. Boards on the showcase's sub-pages are not returned. Cannot be combined with parentBoardId, libraryId or inGeneralLibrary=true; supplying any of them returns a 400. Returns 404 if the showcase does not exist and 403 if you cannot view it.

customFieldstring

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).

libraryIdstring

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

inGeneralLibraryboolean

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

Default

totalinteger

Changes