Skip to content

Function: getCardActions()

ts
function getCardActions(client, parameters): Promise<object[]>;

Defined in: api/cards.ts:177

List the Actions on a Card. See Nested Resources for more information.

Parameters

ParameterTypeDescription
clientClient-
parameters{ before?: string; fields?: unknown; filter?: string | string[]; format?: string; id: unknown; idModels?: string | string[]; limit?: number; member?: boolean; memberCreator?: boolean; memberCreatorFields?: string; memberFields?: string; page?: number; reactions?: boolean; since?: string; }-
parameters.before?stringA date string in the form of YYYY-MM-DDThh:mm:ssZ or a mongo object ID. Only objects created before this date will be returned.
parameters.fields?unknownThe fields to be returned for the Actions. See Action fields here.
parameters.filter?string | string[]A comma-separated list of action types.
parameters.format?stringThe format of the returned Actions. Either list or count.
parameters.idunknownThe ID of the Card
parameters.idModels?string | string[]A comma-separated list of idModels. Only actions related to these models will be returned.
parameters.limit?numberThe limit of the number of responses, between 0 and 1000.
parameters.member?booleanWhether to return the member object for each action.
parameters.memberCreator?booleanWhether to return the memberCreator object for each action.
parameters.memberCreatorFields?stringThe fields of the member creator to return
parameters.memberFields?stringThe fields of the member to return.
parameters.page?numberThe page of results for actions. Each page of results has 50 actions.
parameters.reactions?booleanWhether to show reactions on comments or not.
parameters.since?stringA date string in the form of YYYY-MM-DDThh:mm:ssZ or a mongo object ID. Only objects created since this date will be returned.

Returns

Promise<object[]>