Additional Objects

Action

When the action was performed, and details about the user who did it

Properties

Name	Type	Description	Restrictions
dateTime	string(date-time)	When the action was performed	read-only
user	User¦null	A user refernenced by their unique identifier

Example

{
  "dateTime": "2019-10-30T15:03:27Z",
  "user": {
    "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
  }
}

BearerToken

Bearer token to use in subsequent requests to the Workiva APIs.

Properties

Name	Type	Description	Restrictions
access_token	string	The opaque string used to authorize and make requests on behalf of the user	required
expires_in	integer(int32)	The number of seconds the access token is valid	required
scope	string	The limits of the user’s access with the token, such as Read or Create	required
token_type	string	The type of access token; typically bearer	required

Example

{
  "access_token": "string",
  "expires_in": 0,
  "scope": "string",
  "token_type": "string"
}

ErrorDetails

Additional details of the error

Properties

Name	Type	Description	Restrictions
code	string	One of a server-defined set of error codes.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Example

{
  "code": "InvalidOrder",
  "message": "Ordering by 'name desc' is not supported",
  "target": "name"
}

ErrorResponse

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Properties

Name	Type	Description	Restrictions
code	string	One of a server-defined set of error codes.
details	[ErrorDetails]	A list of additional, more specific details about the error.
documentationUrl	string	Link to some documentation relevant to the issue or endpoint in use.
message	string	A human-readable representation of the error.
target	string	The target of the error.
version	string	The API version in use when the error occurred.

Example

{
  "code": "BadArgument",
  "details": [
    {
      "code": "InvalidOrder",
      "message": "Ordering by 'name desc' is not supported",
      "target": "name"
    }
  ],
  "documentationUrl": "https://developers.workiva.com",
  "message": "The provided $orderBy option is not supported.",
  "target": "$orderBy",
  "version": "2026-01-01"
}

Failure

An error response. All fields other than “errors” are optional

Properties

Name	Type	Description	Restrictions
errors	[object]	The array of error objects describing what went wrong.	required
errors.code	string	An application-specific error code, expressed as a string value
errors.detail	string	A human-readable explanation specific to this occurrence of the problem. Like ‘title’, this field’s value can be localized.
errors.id	string	A unique identifier for this particular occurrence of the problem
errors.links	object
errors.links.about	string	A link that leads to further details about this particular occurrence of the problem
errors.meta	object	Non-standard meta-information that cannot be represented as an attribute or relationship.
errors.source	object
errors.source.parameter	string	A string indicating which URI query parameter caused the error
errors.source.pointer	string	A JSON Pointer [RFC6901] to the associated entity in the request document
errors.status	string	The HTTP status code applicable to this problem, expressed as a string value
errors.title	string	A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization
jsonapi	object	An object describing the server’s implementation of the JSON:API specification.
jsonapi.version	string
links	object	A list of URLs.
meta	object	Non-standard meta-information that cannot be represented as an attribute or relationship.

Example

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "links": {
        "about": "string"
      },
      "meta": {},
      "source": {
        "parameter": "string",
        "pointer": "string"
      },
      "status": "string",
      "title": "string"
    }
  ],
  "jsonapi": {
    "version": "string"
  },
  "links": {},
  "meta": {}
}

GetOrgReportUsersResponse

A report of Organization Users

Properties

Name	Type	Description	Restrictions
data	[object]	The list of organization-user resource objects included in the report.	required
data.attributes	object
data.attributes.active	boolean¦null
data.attributes.displayName	string¦null
data.attributes.email	string¦null
data.attributes.firstName	string¦null
data.attributes.lastLogin	string¦null
data.attributes.lastName	string¦null
data.attributes.licenses	[string]¦null
data.attributes.organizationRoles	[string]¦null
data.attributes.samlId	string¦null
data.attributes.userName	string¦null
data.attributes.workspaceMemberships	[object]¦null
data.attributes.workspaceMemberships.id	string	The Workspace ID
data.attributes.workspaceMemberships.workspaceName	string¦null
data.attributes.workspaceMemberships.workspaceRoles	[string]¦null
data.id	string	The resource ID
data.links	object¦null	A list of URLs.
data.relationships	object¦null
data.type	string	The resource type (File)
included	[object]¦null	Any additional included resources	unique
included.attributes	object
included.id	string	The resource ID
included.type	string	The resource type
jsonapi	object¦null	An object describing the server’s implementation of the JSON:API specification.
jsonapi.version	string
links	object	Pagination links for the report, including the URL of the next page of results.
links.next	string(uri)¦null	The next page of data
meta	object¦null	Non-standard meta-information that cannot be represented as an attribute or relationship.

Enumerated Values

Property	Value
type	orgReportUser
type	File

Example

{
  "data": [
    {
      "attributes": {
        "active": true,
        "displayName": "string",
        "email": "string",
        "firstName": "string",
        "lastLogin": "string",
        "lastName": "string",
        "licenses": [
          "string"
        ],
        "organizationRoles": [
          "string"
        ],
        "samlId": "string",
        "userName": "string",
        "workspaceMemberships": [
          {
            "id": "string",
            "workspaceName": "string",
            "workspaceRoles": [
              "string"
            ]
          }
        ]
      },
      "id": "string",
      "links": {},
      "relationships": {},
      "type": "orgReportUser"
    }
  ],
  "included": [
    {
      "attributes": {},
      "id": "string",
      "type": "string"
    }
  ],
  "jsonapi": {
    "version": "string"
  },
  "links": {
    "next": "http://example.com"
  },
  "meta": {}
}

IamError

Error response object containing an error code.

Properties

Name	Type	Description	Restrictions
error	string	The possible error codes are: - invalid_request - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. - unauthorized_client - The client is not authorized to request an authorization code using this method. - access_denied - The resource owner or authorization server denied the request. - unsupported_response_type - The authorization server does not support obtaining an authorization code using this method. - invalid_scope - The requested scope is invalid, unknown, or malformed. - server_error - The authorization server encountered an unexpected condition that prevented it from fulfilling the request. - temporarily_unavailable - The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
error_description	string	Human-readable ASCII text providing additional information.
error_uri	string	A URI identifying a human-readable web page with information about the error.

Example

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

JSONPatchDocument

Represents a collection of JSON patch operations. For more information, refer to the PATCH Update documentation.

Properties

Name	Type	Description	Restrictions
anonymous	[JSONPatchOperation]	Represents a collection of JSON patch operations. For more information, refer to the PATCH Update documentation.

Example

[
  {
    "op": "replace",
    "path": "/name",
    "value": "New name"
  }
]

JSONPatchOperation

Represents a single JSON Patch operation. For more information, refer to the PATCH Update documentation.

Properties

Name	Type	Description	Restrictions
from	string	A JSON Pointer to the location to copy or move a value from. Required for the move and copy operations.
op	string	The operation to perform.	required
path	string	A JSON Pointer to the target location within the document.	required
value	any	The value to apply. Required for the add, replace, and test operations.

Enumerated Values

Property	Value
op	add
op	remove
op	replace
op	move
op	copy
op	test

Example

{
  "op": "replace",
  "path": "/name",
  "value": "New name"
}

User

A user refernenced by their unique identifier

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the user

Example

{
  "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}