API Reference

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

Properties

NameTypeDescriptionRestrictions
@nextLinkstringPagination 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

NameTypeDescriptionRestrictions
actionActivityActionDetails about the activity action
activityDateTimestring(date-time)When the activity occurredread-only
attachmentsActivityAttachmentsAn array of activity attachments which are generic JSON elements which can provide more context and information
idstringThe unique identifier of the activityread-only
organizationOrganizationThe organization's ID and name
outcomeOutcomeResult of the activity action performed
performerPerformerDetails about the resource that performed an activity
summarystringSummary of the activity performedread-only
tagsActivityTagsAn array of tags for the activity
targetsTargetList
workspaceWorkspaceThe 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

NameTypeDescriptionRestrictions
aliasstringThe legacy identifier of the activity actionread-only
categorystringCategory of the activity actionread-only
deprecatedbooleanWhether or not the activity action has been identified for removalread-only
idstringThe unique identifier of the activity actionread-only
namestringName of the activity actionread-only

Example

{
  "alias": "workspace_membership_create",
  "category": "Administration",
  "deprecated": true,
  "id": "com.workiva.administration.workspace_membership.create",
  "name": "Workspace membership created"
}

ActivityActionsListResult

Properties

NameTypeDescriptionRestrictions
@nextLinkstringPagination 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

NameTypeDescriptionRestrictions
createdActionWhen the action was performed, and details about the user who did itread-only
idstringThe unique identifier of the organizationread-only
modifiedActionWhen the action was performed, and details about the user who did itread-only
namestringThe 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

NameTypeDescriptionRestrictions
stringResult of the activity action performed

Enumerated Values

PropertyValue
anonymoussuccess
anonymousfailure
anonymouspending
anonymousunknown

Example

"success"

Performer

Properties

NameTypeDescriptionRestrictions
displayNamestringDisplay name of the performerread-only
idstringThe unique identifier of the Performerread-only
ipAddressstringThe IP address of origination for the Performerread-only
typestringType of the resource that performed the Activityread-only
uniqueNamestringHuman-friendly identifier of the resource that performed the Activityread-only

Example

{
  "displayName": "Adam Admin",
  "id": "V0ZWc2VyHzE0NT8xNzAyMDA",
  "ipAddress": "192.168.1.1\n",
  "type": "com.workiva.iam.principal.user",
  "uniqueName": "[email protected]"
}

Solution

Properties

NameTypeDescriptionRestrictions
idstringThe unique identifier for the Solution
namestringThe name of the Solution

Example

{
  "id": "60",
  "name": "Connected Global Statutory Reporting (with Entity Management)"
}

Target

Properties

NameTypeDescriptionRestrictions
displayNamestringDisplay name of the targetread-only
idstringThe unique identifier of the targetread-only
typestringType of the target resourceread-only
uniqueNamestringHuman-friendly identifier of the targetread-only

Example

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

Workspace

Properties

NameTypeDescriptionRestrictions
createdActionWhen the action was performed, and details about the user who did itread-only
idstringThe unique identifier of the workspaceread-only
modifiedActionWhen the action was performed, and details about the user who did itread-only
namestringThe name of the workspace
organizationOrganizationThe organization that this workspace belongs toread-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)"
    }
  ]
}