activities

2 endpoints
GET/rest/activities

Get all activities

Returns the activity log for the authenticated user across all files and folders they have access to.

Parameters
Query Parameters
noDayBack
Optional
integer

Number of days back to search

startDate
Optional
string

Start date

endDate
Optional
string

End date

filter
Optional
string

Filter activities by scope. Accepted values: all, my.

search
Optional
string

Search by mail body, subject and sender/recipients

type
Optional
string

Filter activities by type. Accepted values: all, folder_changes, file_changes, user_preferences, mail, tasks, comments, kitepoint.

transactionId
Optional
string

Transaction ID associated with the activities

orderBy
Optional
string[]

Sorting options

offset
Optional
integer

Offset

limit
Optional
integer

Limit

with
Optional
string

With parameters

mode
Optional
string

Determines the detail level of the response body.

Responses

Returns a list of activity records for the authenticated user.

id
integer

Unique identifier of the activity event.

created
string

Date and time when the activity event was recorded.

event
string

Name of the activity event.

message
string

Human-readable summary of the activity event.

type
string

Type category of the activity event.

successful
boolean

Indicates whether the activity completed successfully.

userId
string
name
string

Full name of the user.

email
string

Email address associated with the user.

profileIcon
string

URL or identifier for the user's profile icon.

permissions
string[]

List of permissions required for the activity.

data
any

Additional event-specific data associated with the activity.

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/activities" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

url = "https://{instance}.kiteworks.com/rest/activities"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
[ { "id": 1002, "event": "upload", "message": "User uploaded budget-2024.xlsx", "type": "f", "created": "2024-03-16T08:00:00+00:00", "successful": 1, "user": { "id": 5, "name": "Jane Smith" }, "data": { "file": { "id": 8, "name": "budget-2024.xlsx" } } }, { "id": 1001, "event": "download", "message": "User downloaded quarterly-report.pdf", "type": "f", "created": "2024-03-15T10:30:00+00:00", "successful": 1, "user": { "id": 5, "name": "Jane Smith" }, "data": { "file": { "id": 7, "name": "quarterly-report.pdf" } } } ]
// Error - No Body
GET/rest/files/{file_id}/activities

Get file activities

Returns the activity log for the specified file, scoped to the authenticated user. Requires user_view permission on the file. For Repositories Gateway source files, view permission is required instead.

Parameters
Path Parameters
file_id
Required
string

The unique identifier (UUID) of the file

Query Parameters
noDayBack
Optional
integer

Number of days back to search

startDate
Optional
string

Start date

endDate
Optional
string

End date

filter
Optional
string

Filter activities by scope. Accepted values: all, my.

search
Optional
string

Search by mail body, subject and sender/recipients

type
Optional
string

Filter activities by type. Accepted values: all, folder_changes, file_changes, user_preferences, mail, tasks, comments, kitepoint.

transactionId
Optional
string

Transaction ID associated with the activities

orderBy
Optional
string[]

Sorting options

offset
Optional
integer

Offset

limit
Optional
integer

Limit

with
Optional
string

With parameters

mode
Optional
string

Determines the detail level of the response body.

Responses

Returns a list of activity records for the specified file.

id
integer

Unique identifier of the activity event.

created
string

Date and time when the activity event was recorded.

event
string

Name of the activity event.

message
string

Human-readable summary of the activity event.

type
string

Type category of the activity event.

successful
boolean

Indicates whether the activity completed successfully.

userId
string
name
string

Full name of the user.

email
string

Email address associated with the user.

profileIcon
string

URL or identifier for the user's profile icon.

permissions
string[]

List of permissions required for the activity.

data
any

Additional event-specific data associated with the activity.

Request blocked by WAF

Empty response body.
Shell
curl -X GET \
  "https://{instance}.kiteworks.com/rest/files/:file_id/activities" \
  -H "Authorization: Bearer YOUR_TOKEN"
Python
import requests

file_id = "VALUE"  # The unique identifier (UUID) of the file

url = f"https://{{instance}}.kiteworks.com/rest/files/{file_id}/activities"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())
Responses
[ { "id": 1001, "event": "download", "message": "User downloaded quarterly-report.pdf", "type": "f", "created": "2024-03-15T10:30:00+00:00", "successful": 1, "user": { "id": 5, "name": "Jane Smith" }, "data": { "file": { "id": 7, "name": "quarterly-report.pdf" } } }, { "id": 1000, "event": "view", "message": "User viewed quarterly-report.pdf", "type": "f", "created": "2024-03-15T09:00:00+00:00", "successful": 1, "user": { "id": 5, "name": "Jane Smith" }, "data": { "file": { "id": 7, "name": "quarterly-report.pdf" } } } ]
// Error - No Body
Previouswebhook
Nextadmin