v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

Describes the user activities in a specified time period.

get/api/v1/activities

Query parameters

startTimestring date-time

The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

endTimestring date-time

The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

organizationIdstring

The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

activityTypesstring

Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

resourceIdstring

The document or folder ID for which to describe activity types.

userIdstring

The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.

includeIndirectActivitiesboolean

Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

limitinteger

The maximum number of items to return.

markerstring

The marker for the next set of results.

Limitstring

Pagination limit

Markerstring

Pagination token

Headers

Authenticationstring password

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Response

Success

Markerstring

The marker for the next set of results.