For the complete documentation index, see llms.txt. This page is also available as Markdown.

Activities

Returns activities matching the given search criteria.

get

Returns activities matching the given search criteria.Only parameters that are specified in this request and have not null values are used for filtering.All other parameters are ignored.The returned activities satisfy all constraints that are specified in this search criteria.By default a result containing 100 activities is returned.

Authorizations
AuthorizationstringRequired
Query parameters
offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0
limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0
countLimitinteger · int32OptionalDeprecated

Parameter not used in the context of activities, for performance reasons they are not counted.

Default: -1
taskIdstring · uuidOptional

The ID of the task which contains the basic find activities request.

contextIdstring · uuidOptional

The ID of the context which the activities should be searched for.

involvedPeopleIdsstring · uuid[]Optional

The list of IDs of the people that should be involved in searched activities.

involvedRoleIdsstring · uuid[]Optional

The list of IDs of the roles that should be involved in searched activities.

performedByUserIdstring · uuidOptional

The ID of the user who performed searched activities.

performedByRoleIdsstring · uuid[]Optional

The list of IDs of the roles assigned to users who performed searched activities.

activityTypestring · enumOptional

The type of the activity.

Possible values:
callIdstringOptional

The ID of the call.

resourceDiscriminatorsstring[]Optional

The set of the resource discriminators that searched activities refer to, i.e. [Community, Asset, Domain, Attribute,
Relation, WorkflowInstance].

startDateinteger · int64Optional

The start date of the searched activities, expressed as a Unix timestamp in milliseconds.

endDateinteger · int64Optional

The end date of the searched activities, expressed as a Unix timestamp in milliseconds.

callCountEnabledbooleanOptional

Flag to indicate if the number of calls standing behind the activity should be returned or not.
Note that by default that count will be not calculated as it brings an important performance penalty.

Default: false
Responses
200

The paged response with found Activity information. The total number of results is not calculated and should be ignored

No content

get/activities
200

The paged response with found Activity information. The total number of results is not calculated and should be ignored

No content

Last updated

Was this helpful?