Activities enable you to retrieve a list of actions performed in the organization or a specific workspace, such as:
- User logins
- Added users
- Changes to roles
- Changes to organization or workspace settings
To access activities through this API or in Workiva, a user must have a valid admin role:
- Org User Admin
- Org Workspace Admin
- Org Security Admin, for organization activities
- Workspace Owner, for workspace activities
ActivitiesListResult
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
@nextLink | string | Pagination link for next set of results | |
data | [Activity] | [Details about the activity] |
Example
{
"@nextLink": "string",
"data": [
{
"action": {
"alias": "workspace_membership_create",
"category": "Administration",
"deprecated": true,
"id": "com.workiva.administration.workspace_membership.create",
"name": "Workspace membership created"
},
"activityDateTime": "2021-01-30T13:55:01Z",
"attachments": [
{
"enabled": {
"new": true,
"old": false
}
}
],
"id": "NjE0MjIxODItOTVkYi00YmFjLWI4ZjktNzRkMDg1OTdlMDgwOlFYVmthWFJNYjJjZVFYVmthWFJNYjJjNk5ETXpaamN4TUdVMU5HRTBOR1V5Tm1JeU5ERmtOREJsWXpNMlpHWXhNVFE=",
"organization": {
"created": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"active": true,
"cellPhone": "string",
"companyName": "string",
"created": null,
"displayName": "string",
"email": "string",
"firstName": "string",
"homePhone": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
"jobTitle": "string",
"lastLogin": "2019-10-30T00:00:00Z",
"lastName": "string",
"middleName": "string",
"modified": null,
"officePhone": "string",
"sourceUrl": "string",
"suffix": "string",
"userName": "string"
}
},
"id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
"modified": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"active": true,
"cellPhone": "string",
"companyName": "string",
"created": null,
"displayName": "string",
"email": "string",
"firstName": "string",
"homePhone": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
"jobTitle": "string",
"lastLogin": "2019-10-30T00:00:00Z",
"lastName": "string",
"middleName": "string",
"modified": null,
"officePhone": "string",
"sourceUrl": "string",
"suffix": "string",
"userName": "string"
}
},
"name": "Workiva Inc."
},
"outcome": "success",
"performer": {
"displayName": "Adam Admin",
"id": "V0ZWc2VyHzE0NT8xNzAyMDA",
"ipAddress": "192.168.1.1\n",
"type": "com.workiva.iam.principal.user",
"uniqueName": "[email protected]"
},
"summary": "Adam Admin added the user 'John Public' to the workspace 'Organization Management'",
"tags": [
"correlationId:1a2b3c4d5e6f000db88c0009f9f1",
"eventId:LM4s-wJyTgW4NTbNZi_86v"
],
"targets": [
{
"displayName": "John Public",
"id": "V0ZVc2VyHzY0ODY4NjQ1MzE1NTQ",
"type": "com.workiva.administration.user",
"uniqueName": "john_public"
}
],
"workspace": {
"created": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"active": true,
"cellPhone": "string",
"companyName": "string",
"created": null,
"displayName": "string",
"email": "string",
"firstName": "string",
"homePhone": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
"jobTitle": "string",
"lastLogin": "2019-10-30T00:00:00Z",
"lastName": "string",
"middleName": "string",
"modified": null,
"officePhone": "string",
"sourceUrl": "string",
"suffix": "string",
"userName": "string"
}
},
"id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
"modified": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"active": true,
"cellPhone": "string",
"companyName": "string",
"created": null,
"displayName": "string",
"email": "string",
"firstName": "string",
"homePhone": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
"jobTitle": "string",
"lastLogin": "2019-10-30T00:00:00Z",
"lastName": "string",
"middleName": "string",
"modified": null,
"officePhone": "string",
"sourceUrl": "string",
"suffix": "string",
"userName": "string"
}
},
"name": "Quarterly Planning",
"organization": {
"created": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"active": true,
"cellPhone": "string",
"companyName": "string",
"created": null,
"displayName": "string",
"email": "string",
"firstName": "string",
"homePhone": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
"jobTitle": "string",
"lastLogin": "2019-10-30T00:00:00Z",
"lastName": "string",
"middleName": "string",
"modified": null,
"officePhone": "string",
"sourceUrl": "string",
"suffix": "string",
"userName": "string"
}
},
"id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
"modified": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"active": true,
"cellPhone": "string",
"companyName": "string",
"created": null,
"displayName": "string",
"email": "string",
"firstName": "string",
"homePhone": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
"jobTitle": "string",
"lastLogin": "2019-10-30T00:00:00Z",
"lastName": "string",
"middleName": "string",
"modified": null,
"officePhone": "string",
"sourceUrl": "string",
"suffix": "string",
"userName": "string"
}
},
"name": "Workiva Inc."
},
"solutions": [
{
"id": "60",
"name": "Connected Global Statutory Reporting (with Entity Management)"
}
]
}
}
]
}
Activity
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
action | ActivityAction | Details about the activity action | |
activityDateTime | string(date-time) | When the activity occurred | read-only |
attachments | ActivityAttachments | An array of activity attachments which are generic JSON elements which can provide more context and information | |
id | string | The unique identifier of the activity | read-only |
organization | Organization | The organization's ID and name | |
outcome | Outcome | Result of the activity action performed | |
performer | Performer | Details about the resource that performed an activity | |
summary | string | Summary of the activity performed | read-only |
tags | ActivityTags | An array of tags for the activity | |
targets | TargetList | ||
workspace | Workspace | The workspace's ID and name |
Example
{
"action": {
"alias": "workspace_membership_create",
"category": "Administration",
"deprecated": true,
"id": "com.workiva.administration.workspace_membership.create",
"name": "Workspace membership created"
},
"activityDateTime": "2021-01-30T13:55:01Z",
"attachments": [
{
"enabled": {
"new": true,
"old": false
}
}
],
"id": "NjE0MjIxODItOTVkYi00YmFjLWI4ZjktNzRkMDg1OTdlMDgwOlFYVmthWFJNYjJjZVFYVmthWFJNYjJjNk5ETXpaamN4TUdVMU5HRTBOR1V5Tm1JeU5ERmtOREJsWXpNMlpHWXhNVFE=",
"organization": {
"id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
"name": "Workiva Inc."
},
"outcome": "success",
"performer": {
"displayName": "Adam Admin",
"id": "V0ZWc2VyHzE0NT8xNzAyMDA",
"ipAddress": "192.168.1.1\n",
"type": "com.workiva.iam.principal.user",
"uniqueName": "[email protected]"
},
"summary": "Adam Admin added the user 'John Public' to the workspace 'Organization Management'",
"tags": [
"correlationId:1a2b3c4d5e6f000db88c0009f9f1",
"eventId:LM4s-wJyTgW4NTbNZi_86v"
],
"targets": [
{
"displayName": "John Public",
"id": "V0ZVc2VyHzY0ODY4NjQ1MzE1NTQ",
"type": "com.workiva.administration.user",
"uniqueName": "john_public"
}
],
"workspace": {
"id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
"name": "Quarterly Planning"
}
}
ActivityAction
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
alias | string | The legacy identifier of the activity action | read-only |
category | string | Category of the activity action | read-only |
deprecated | boolean | Whether or not the activity action has been identified for removal | read-only |
id | string | The unique identifier of the activity action | read-only |
name | string | Name of the activity action | read-only |
Example
{
"alias": "workspace_membership_create",
"category": "Administration",
"deprecated": true,
"id": "com.workiva.administration.workspace_membership.create",
"name": "Workspace membership created"
}
ActivityActionsListResult
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
@nextLink | string | Pagination link for next set of results | |
data | [ActivityAction] | [Details about the activity action] |
Example
{
"@nextLink": "string",
"data": [
{
"alias": "workspace_membership_create",
"category": "Administration",
"deprecated": true,
"id": "com.workiva.administration.workspace_membership.create",
"name": "Workspace membership created"
}
]
}
ActivityAttachments
Properties
None
Example
[
{
"enabled": {
"new": true,
"old": false
}
}
]
ActivityTags
Properties
None
Example
[
"correlationId:1a2b3c4d5e6f000db88c0009f9f1",
"eventId:LM4s-wJyTgW4NTbNZi_86v"
]
Organization
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
created | Action | When the action was performed, and details about the user who did it | read-only |
id | string | The unique identifier of the organization | read-only |
modified | Action | When the action was performed, and details about the user who did it | read-only |
name | string | The name of the organization |
Example
{
"created": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"displayName": "string",
"email": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}
},
"id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
"modified": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"displayName": "string",
"email": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}
},
"name": "Workiva Inc."
}
Outcome
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
string | Result of the activity action performed |
Enumerated Values
Property | Value |
---|---|
anonymous | success |
anonymous | failure |
anonymous | pending |
anonymous | unknown |
Example
"success"
Performer
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
displayName | string | Display name of the performer | read-only |
id | string | The unique identifier of the Performer | read-only |
ipAddress | string | The IP address of origination for the Performer | read-only |
type | string | Type of the resource that performed the Activity | read-only |
uniqueName | string | Human-friendly identifier of the resource that performed the Activity | read-only |
Example
{
"displayName": "Adam Admin",
"id": "V0ZWc2VyHzE0NT8xNzAyMDA",
"ipAddress": "192.168.1.1\n",
"type": "com.workiva.iam.principal.user",
"uniqueName": "[email protected]"
}
Solution
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
id | string | The unique identifier for the Solution | |
name | string | The name of the Solution |
Example
{
"id": "60",
"name": "Connected Global Statutory Reporting (with Entity Management)"
}
Target
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
displayName | string | Display name of the target | read-only |
id | string | The unique identifier of the target | read-only |
type | string | Type of the target resource | read-only |
uniqueName | string | Human-friendly identifier of the target | read-only |
Example
{
"displayName": "John Public",
"id": "V0ZVc2VyHzY0ODY4NjQ1MzE1NTQ",
"type": "com.workiva.administration.user",
"uniqueName": "john_public"
}
Workspace
Properties
Name | Type | Description | Restrictions |
---|---|---|---|
created | Action | When the action was performed, and details about the user who did it | read-only |
id | string | The unique identifier of the workspace | read-only |
modified | Action | When the action was performed, and details about the user who did it | read-only |
name | string | The name of the workspace | |
organization | Organization | The organization that this workspace belongs to | read-only |
solutions | [Solution] | [A set of capabilities available to an Organization ] |
Example
{
"created": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"displayName": "string",
"email": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}
},
"id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
"modified": {
"dateTime": "2019-10-30T15:03:27Z",
"user": {
"displayName": "string",
"email": "string",
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}
},
"name": "Quarterly Planning",
"organization": {
"id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
"name": "Workiva Inc."
},
"solutions": [
{
"id": "60",
"name": "Connected Global Statutory Reporting (with Entity Management)"
}
]
}