Activities

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

These activities are also available in the Workiva platform and can be exported from Organization Admin 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

Learn more about these roles here and Workiva activities here.

ActivitiesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Activity objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Activity]	Details about the activity	required

Example

{
  "@nextLink": "<opaque_url>",
  "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": {
            "displayName": "John Doe",
            "email": "string",
            "firstName": "John",
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
            "lastName": "Doe",
            "userName": "string"
          }
        },
        "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
        "modified": {
          "dateTime": "2019-10-30T15:03:27Z",
          "user": {
            "displayName": "John Doe",
            "email": "string",
            "firstName": "John",
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
            "lastName": "Doe",
            "userName": "string"
          }
        },
        "name": "Workiva Inc.",
        "status": "active"
      },
      "outcome": "success",
      "performer": {
        "displayName": "Adam Admin",
        "id": "V0ZWc2VyHzE0NT8xNzAyMDA",
        "ipAddress": "192.168.1.1\n",
        "type": "com.workiva.iam.principal.user",
        "uniqueName": "admin_admin@example.com"
      },
      "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": {
            "displayName": "John Doe",
            "email": "string",
            "firstName": "John",
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
            "lastName": "Doe",
            "userName": "string"
          }
        },
        "id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
        "modified": {
          "dateTime": "2019-10-30T15:03:27Z",
          "user": {
            "displayName": "John Doe",
            "email": "string",
            "firstName": "John",
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
            "lastName": "Doe",
            "userName": "string"
          }
        },
        "name": "Quarterly Planning",
        "organization": {
          "created": {
            "dateTime": "2019-10-30T15:03:27Z",
            "user": {
              "displayName": "John Doe",
              "email": "string",
              "firstName": "John",
              "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
              "lastName": "Doe",
              "userName": "string"
            }
          },
          "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
          "modified": {
            "dateTime": "2019-10-30T15:03:27Z",
            "user": {
              "displayName": "John Doe",
              "email": "string",
              "firstName": "John",
              "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
              "lastName": "Doe",
              "userName": "string"
            }
          },
          "name": "Workiva Inc.",
          "status": "active"
        },
        "solutions": [
          {
            "id": "60",
            "name": "Connected Global Statutory Reporting (with Entity Management)"
          }
        ]
      }
    }
  ]
}

Activity

Details about the activity

Properties

Name	Type	Description	Restrictions
action	ActivityAction	Details about the activity action	required
activityDateTime	string(date-time)	When the activity occurred	read-only, required
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, required
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	required
summary	string	Summary of the activity performed	read-only
tags	ActivityTags	An array of tags for the activity
targets	TargetList		required
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": "admin_admin@example.com"
  },
  "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

Details about the activity action

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, required
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

Returns a JSON object with data and @nextLink properties. data contains a list of ActivityAction objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[ActivityAction]	Details about the activity action	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "alias": "workspace_membership_create",
      "category": "Administration",
      "deprecated": true,
      "id": "com.workiva.administration.workspace_membership.create",
      "name": "Workspace membership created"
    }
  ]
}

ActivityAttachments

An array of activity attachments which are generic JSON elements which can provide more context and information

Properties

None

Example

[
  {
    "enabled": {
      "new": true,
      "old": false
    }
  }
]

ActivityTags

An array of tags for the activity

Properties

None

Example

[
  "correlationId:1a2b3c4d5e6f000db88c0009f9f1",
  "eventId:LM4s-wJyTgW4NTbNZi_86v"
]

Organization

Details about the 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
status	string		read-only

Enumerated Values

Property	Value
status	active
status	inactive

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Workiva Inc.",
  "status": "active"
}

Outcome

Result of the activity action performed

Properties

Name	Type	Description	Restrictions
anonymous	string	Result of the activity action performed

Enumerated Values

Property	Value
anonymous	success
anonymous	failure
anonymous	pending
anonymous	unknown

Example

"success"

Performer

Details about the resource that performed an activity

Properties

Name	Type	Description	Restrictions
displayName	string	Display name of the performer	read-only
id	string	The unique identifier of the Performer	read-only, required
ipAddress	string	The IP address of origination for the Performer	read-only
type	string	Type of the resource that performed the Activity	read-only, required
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": "admin_admin@example.com"
}

Solution

A set of capabilities available to an Organization

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

Details about the resource affected by an Activity

Properties

Name	Type	Description	Restrictions
displayName	string	Display name of the target	read-only
id	string	The unique identifier of the target	read-only, required
type	string	Type of the target resource	read-only, required
uniqueName	string	Human-friendly identifier of the target	read-only

Example

{
  "displayName": "John Public",
  "id": "V0ZVc2VyHzY0ODY4NjQ1MzE1NTQ",
  "type": "com.workiva.administration.user",
  "uniqueName": "john_public"
}

TargetList

Properties

Name	Type	Description	Restrictions
anonymous	[Target]	Details about the resource affected by an Activity

Example

[
  {
    "displayName": "John Public",
    "id": "V0ZVc2VyHzY0ODY4NjQ1MzE1NTQ",
    "type": "com.workiva.administration.user",
    "uniqueName": "john_public"
  }
]

Workspace

Details about a 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	Maximum items: 1

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "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)"
    }
  ]
}