--- title: "GET /api/v1/activities" method: GET path: "/api/v1/activities" --- # GET /api/v1/activities `GET /api/v1/activities` Describes the user activities in a specified time period. ## Query parameters - `startTime` string, date-time - `endTime` string, date-time - `organizationId` string - `activityTypes` string - `resourceId` string - `userId` string - `includeIndirectActivities` boolean - `limit` integer - `marker` string - `Limit` string - `Marker` string ## Headers - `Authentication` string, password ## Response `200` Success - DescribeActivitiesResponse - `UserActivities` Activity[] — The list of activities for the specified user and time period. - `Type` 'DOCUMENT_CHECKED_IN' | 'DOCUMENT_CHECKED_OUT' | 'DOCUMENT_RENAMED' | 'DOCUMENT_VERSION_UPLOADED' | 'DOCUMENT_VERSION_DELETED' | 'DOCUMENT_VERSION_VIEWED' | 'DOCUMENT_VERSION_DOWNLOADED' | 'DOCUMENT_RECYCLED' | 'DOCUMENT_RESTORED' | 'DOCUMENT_REVERTED' | 'DOCUMENT_SHARED' | 'DOCUMENT_UNSHARED' | 'DOCUMENT_SHARE_PERMISSION_CHANGED' | 'DOCUMENT_SHAREABLE_LINK_CREATED' | 'DOCUMENT_SHAREABLE_LINK_REMOVED' | 'DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED' | 'DOCUMENT_MOVED' | 'DOCUMENT_COMMENT_ADDED' | 'DOCUMENT_COMMENT_DELETED' | 'DOCUMENT_ANNOTATION_ADDED' | 'DOCUMENT_ANNOTATION_DELETED' | 'FOLDER_CREATED' | 'FOLDER_DELETED' | 'FOLDER_RENAMED' | 'FOLDER_RECYCLED' | 'FOLDER_RESTORED' | 'FOLDER_SHARED' | 'FOLDER_UNSHARED' | 'FOLDER_SHARE_PERMISSION_CHANGED' | 'FOLDER_SHAREABLE_LINK_CREATED' | 'FOLDER_SHAREABLE_LINK_REMOVED' | 'FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED' | 'FOLDER_MOVED' — The activity type. - `TimeStamp` string, date-time — The timestamp when the action was performed. - `IsIndirectActivity` boolean — Indicates whether an activity is indirect or direct. 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). - `OrganizationId` string — The ID of the organization. - `Initiator` object — The user who performed the action. - `Id` string — The ID of the user. - `Username` string, password — The name of the user. - `GivenName` string, password — The given name of the user before a rename operation. - `Surname` string, password — The surname of the user. - `EmailAddress` string, password — The email address of the user. - `Participants` object — The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED. - `Users` UserMetadata[] — The list of users. - `Id` string — The ID of the user. - `Username` string, password — The name of the user. - `GivenName` string, password — The given name of the user before a rename operation. - `Surname` string, password — The surname of the user. - `EmailAddress` string, password — The email address of the user. - `Groups` GroupMetadata[] — The list of user groups. - `Id` string — The ID of the user group. - `Name` string — The name of the group. - `ResourceMetadata` object — The metadata of the resource involved in the user action. - `Type` 'FOLDER' | 'DOCUMENT' — The type of resource. - `Name` string, password — The name of the resource. - `OriginalName` string, password — The original name of the resource before a rename operation. - `Id` string — The ID of the resource. - `VersionId` string — The version ID of the resource. This is an optional field and is filled for action on document version. - `Owner` object — The owner of the resource. - `Id` string — The ID of the user. - `Username` string, password — The name of the user. - `GivenName` string, password — The given name of the user before a rename operation. - `Surname` string, password — The surname of the user. - `EmailAddress` string, password — The email address of the user. - `ParentId` string — The parent ID of the resource before a rename operation. - `OriginalParent` object — The original parent of the resource. This is an optional field and is filled for move activities. - `Type` 'FOLDER' | 'DOCUMENT' — The type of resource. - `Name` string, password — The name of the resource. - `OriginalName` string, password — The original name of the resource before a rename operation. - `Id` string — The ID of the resource. - `VersionId` string — The version ID of the resource. This is an optional field and is filled for action on document version. - `Owner` object — The owner of the resource. - `Id` string — The ID of the user. - `Username` string, password — The name of the user. - `GivenName` string, password — The given name of the user before a rename operation. - `Surname` string, password — The surname of the user. - `EmailAddress` string, password — The email address of the user. - `ParentId` string — The parent ID of the resource before a rename operation. - `CommentMetadata` object — Metadata of the commenting activity. This is an optional field and is filled for commenting activities. - `CommentId` string — The ID of the comment. - `Contributor` object — The user who made the comment. - `Id` string — The ID of the user. - `Username` string, password — The login name of the user. - `EmailAddress` string, password — The email address of the user. - `GivenName` string, password — The given name of the user. - `Surname` string, password — The surname of the user. - `OrganizationId` string — The ID of the organization. - `RootFolderId` string — The ID of the root folder. - `RecycleBinFolderId` string — The ID of the recycle bin folder. - `Status` 'ACTIVE' | 'INACTIVE' | 'PENDING' — The status of the user. - `Type` 'USER' | 'ADMIN' | 'POWERUSER' | 'MINIMALUSER' | 'WORKSPACESUSER' — The type of user. - `CreatedTimestamp` string, date-time — The time when the user was created. - `ModifiedTimestamp` string, date-time — The time when the user was modified. - `TimeZoneId` string — The time zone ID of the user. - `Locale` 'en' | 'fr' | 'ko' | 'de' | 'es' | 'ja' | 'ru' | 'zh_CN' | 'zh_TW' | 'pt_BR' | 'default' — The locale of the user. - `Storage` object — The storage for the user. - `StorageUtilizedInBytes` integer — The amount of storage used, in bytes. - `StorageRule` object — The storage for a user. - `StorageAllocatedInBytes` integer — The amount of storage allocated, in bytes. - `StorageType` 'UNLIMITED' | 'QUOTA' — The type of storage. - `CreatedTimestamp` string, date-time — The timestamp that the comment was created. - `CommentStatus` 'DRAFT' | 'PUBLISHED' | 'DELETED' — The status of the comment. - `RecipientId` string — The ID of the user being replied to. - `ContributorId` string — The ID of the user who made the comment. - `Marker` string — The marker for the next set of results. ## Other responses - `480` — UnauthorizedOperationException - `481` — UnauthorizedResourceAccessException - `482` — InvalidArgumentException - `483` — FailedDependencyException - `484` — ServiceUnavailableException --- [API](https://skmtc.net/aws/apis/workdocs.md) · [All operations](https://skmtc.net/aws/apis/workdocs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workdocs/versions/8a533af4e1ef/schema)