Function: getOrganizationActions()
ts
function getOrganizationActions(client, parameters): Promise<object[]>;Defined in: api/organizations.ts:115
List the actions on a Workspace
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
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? | string | A 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? | unknown | The fields to be returned for the Actions. See Action fields here. |
parameters.filter? | string | string[] | A comma-separated list of action types. |
parameters.format? | string | The format of the returned Actions. Either list or count. |
parameters.id | unknown | The ID or name of the organization |
parameters.idModels? | string | string[] | A comma-separated list of idModels. Only actions related to these models will be returned. |
parameters.limit? | number | The limit of the number of responses, between 0 and 1000. |
parameters.member? | boolean | Whether to return the member object for each action. |
parameters.memberCreator? | boolean | Whether to return the memberCreator object for each action. |
parameters.memberCreatorFields? | string | The fields of the member creator to return |
parameters.memberFields? | string | The fields of the member to return. |
parameters.page? | number | The page of results for actions. |
parameters.reactions? | boolean | Whether to show reactions on comments or not. |
parameters.since? | string | A 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[]>