Skip to content

Function: getBoardPropertyKeys() ​

ts
function getBoardPropertyKeys(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Defined in: src/agile/api/board.ts:537

Returns the keys of all properties for the board identified by the id. The user who retrieves the property keys is required to have permissions to view the board.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ boardId: string; }-
parameters.boardIdstringThe ID of the board from which property keys will be returned.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>