Summary: Updated APIs for Integration. Updated APIs for Workspace.

Integration

Link to the documentation

Integration (v v2)

---

What's Changed

---

POST /integration/v2/workspace/folders

Request:

Changed content type : application/json

• Changed property parentFolderId (string)

  UUID of the parent folder where the new folder will be created. Use "root" to create at the user's root level.

Return Type:

Changed response : 201 Created

Created

• Changed content type : application/json; charset=utf-8
  • Changed property type (string)

    The content type of this item; Here, it is always the "folder"

  • Changed property applicationUrls (array)

    List of application-specific URLs for accessing this folder in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

POST /integration/v2/workspace/folders/{workspaceFolderId}/copy

Parameters:

Changed: workspaceFolderId in path

The unique identifier of the workspace folder to copy.

Request:

Changed content type : application/json

• Changed property parentFolderId (string -> number)

  UUID of the destination folder where the folder copy will be placed. Use "root" to copy the folder to the user's root level.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property type (string)

    The content type of this item; Here, it is always the "folder"

  • Changed property applicationUrls (array)

    List of application-specific URLs for accessing this folder in Seismic applications.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

POST /integration/v2/workspace/folders/createContextualFolder

Request:

Changed content type : application/json

• Changed property systemType (string)

  The CRM system type. Supported values are Salesforce, MicrosoftDynamicsCRM, Hubspot, OracleCX. Case-sensitive.
  Removed enum values:

  • Salesforce
  • MicrosoftDynamicsCRM
  • Hubspot
  • OracleCX

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property type (string)

    The content type of this item; Here, it is always the "folder"

  • Changed property applicationUrls (array)

    List of application-specific URLs for accessing this folder in Seismic applications.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

POST /integration/v2/workspace/files

Return Type:

Changed response : 201 Created

Created

• Changed content type : application/json; charset=utf-8
  • Changed property deliveryOptions (array)

    List of delivery option identifiers available for delivery this file.

  • Changed property applicationUrls (array)

    List of application-specific URLs for accessing this file in Seismic applications.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

GET /integration/v2/workspace/files/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace file to retrieve information for.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property deliveryOptions (array)

    Array of delivery option references available for delivery this file.

  • Changed property applicationUrls (array)

    List of named URLs for accessing this item in Seismic..
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

DELETE /integration/v2/workspace/files/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace file to delete.

Return Type:

Changed response : 401 Unauthorized

Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

• Changed content type : application/problem+json
  Changed response : 403 Forbidden

  Forbidden - the authenticated user lacks permission to perform this operation. Verify the required scope is granted and that the user has the necessary role on the target resource before retrying.

• Changed content type : application/problem+json
  Changed response : 404 Not Found

  Not Found - the requested file does not exist or the authenticated user cannot see it. Verify the workspaceContentId is correct and that the file has not been deleted before retrying.

• Changed content type : application/problem+json

PATCH /integration/v2/workspace/files/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace file to update.

Request:

Changed content type : application/json

• Changed property parentFolderId (string)

  UUID of the destination folder to move the file to. Use "root" for the user's root folder.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json; charset=utf-8
  • Changed property deliveryOptions (array)

    Array of delivery option references available for delivery this file.

  • Changed property applicationUrls (array)

    List of named URLs for accessing this item in Seismic..
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

POST /integration/v2/workspace/files/{workspaceContentId}/copy

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace file to copy.

Request:

Changed content type : application/json

• Changed property parentFolderId (string)

  UUID of the destination folder where the file copy will be created. Use "root" for the user's root folder.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening the copy in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

GET /integration/v2/workspace/files/{workspaceContentId}/content

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace file whose binary content to download.

PUT /integration/v2/workspace/files/{workspaceContentId}/content

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace file to upload a new version for.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property deliveryOptions (array)

    Array of delivery option references available for delivery this file.

  • Changed property applicationUrls (array)

    List of named URLs for accessing this item in Seismic..
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

GET /integration/v2/workspace/urls/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace URL item to retrieve.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json; charset=utf-8
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening this URL item in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

DELETE /integration/v2/workspace/urls/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace URL item to delete.

Return Type:

Changed response : 401 Unauthorized

Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

• Changed content type : application/problem+json
  Changed response : 403 Forbidden

  Forbidden - the authenticated user lacks permission to perform this operation. Verify the required scope is granted and that the user has the necessary role on the target resource before retrying.

• Changed content type : application/problem+json
  Changed response : 404 Not Found

  Not Found - the requested URL item does not exist or the authenticated user cannot see it. Verify the workspaceContentId is correct and that the URL item has not been deleted before retrying.

• Changed content type : application/problem+json

PATCH /integration/v2/workspace/urls/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace URL item to update.

Request:

Changed content type : application/json

• Changed property parentFolderId (string)

  UUID of the destination folder to move the URL item to. Use "root" for the user's root folder.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening this URL item in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

POST /integration/v2/workspace/urls/{workspaceContentId}/copy

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace URL item to copy.

Request:

Changed content type : application/json

• Changed property ParentFolderId (string)

  UUID of the destination folder where the URL item copy will be created. Use "root" for the user's root folder. Note - this field is intentionally PascalCase for backward compatibility with the legacy API contract.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json; charset=utf-8
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening the copy in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

GET /integration/v2/workspace/items/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace item (file, folder, or URL) to retrieve.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json; charset=utf-8
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening this item in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

DELETE /integration/v2/workspace/items/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace item (file, folder, or URL) to delete.

PATCH /integration/v2/workspace/items/{workspaceContentId}

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace item (file, folder, or URL) to update.

Request:

Changed content type : application/json

• Changed property parentFolderId (string)

  UUID of the destination folder to move the item to. Use "root" for the user's root folder.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json; charset=utf-8
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening this item in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

POST /integration/v2/workspace/items/{workspaceContentId}/copy

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace item (file, folder, or URL) to copy.

Request:

Changed content type : application/json

• Changed property parentFolderId (string)

  UUID of the destination folder where the item copy will be created. Use "root" for the user's root folder.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json; charset=utf-8
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening the copy in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

GET /integration/v2/workspace/folders/{workspaceFolderId}

Parameters:

Changed: workspaceFolderId in path

The unique identifier of the workspace folder to retrieve. Use "root" for the user's root folder.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property type (string)

    Item type discriminator; "folder" for standard folders for the user's root folder.

  • Changed property applicationUrls (array)

    List of application-specific URLs for opening this folder in Seismic.

DELETE /integration/v2/workspace/folders/{workspaceFolderId}

Parameters:

Changed: workspaceFolderId in path

The unique identifier of the workspace folder to delete.

Return Type:

Changed response : 400 Bad Request

Bad Request - the workspaceFolderId is invalid or the folder cannot be deleted (for example, contextual folders cannot be removed). Validate the identifier and folder type before retrying.

• New content type : application/json
• Deleted content type : application/problem+json

PATCH /integration/v2/workspace/folders/{workspaceFolderId}

Parameters:

Changed: workspaceFolderId in path

The unique identifier of the workspace folder to rename or move.

Request:

Changed content type : application/json

• Changed property parentFolderId (string)

  UUID of the new parent folder to move this folder to. Use "root" for the user's root folder.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening this folder in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

GET /integration/v2/workspace/{workspaceContentId}/members

Parameters:

Changed: workspaceContentId in path

The unique identifier of the workspace item whose member list to retrieve.

POST /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments/{commentId}/reply

Parameters:

Changed: spaceId in path

The unique identifier of the workspace space that contains the item.
Changed: workspaceContentId in path
The unique identifier of the workspace item containing the comment to reply to.
Changed: workspaceVersionId in path
The unique identifier of the workspace item version the comment belongs to.
Changed: commentId in path
The unique identifier of the comment to add a reply to.

Return Type:

Changed response : 400 Bad Request

Bad Request - the reply body is malformed (missing text, bad @mention syntax, or unescaped braces). Validate the payload against the operation schema before retrying.

• Changed content type : application/problem+json
  Changed response : 401 Unauthorized

  Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

• Changed content type : application/problem+json
  Changed response : 403 Forbidden

  Forbidden - the authenticated user lacks permission to reply to comments on this item. Verify the seismic.workspace.manage scope is granted and that the user has access to the item before retrying.

• Changed content type : application/problem+json
  Changed response : 404 Not Found

  Not Found - the specified space, item, version, or parent comment does not exist or the authenticated user cannot see it. Verify all path identifiers are correct before retrying.

• Changed content type : application/problem+json

DELETE /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments/{commentId}

Parameters:

Changed: spaceId in path

The unique identifier of the workspace space that contains the item.
Changed: workspaceContentId in path
The unique identifier of the workspace item the comment belongs to.
Changed: workspaceVersionId in path
The unique identifier of the workspace item version the comment belongs to.
Changed: commentId in path
The unique identifier of the comment to delete.

Return Type:

Changed response : 401 Unauthorized

Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

• Changed content type : application/problem+json
  Changed response : 403 Forbidden

  Forbidden - the authenticated user lacks permission to delete this comment. Only the comment author or users with manage permission on the item may delete it.

• Changed content type : application/problem+json
  Changed response : 404 Not Found

  Not Found - the specified comment does not exist or the authenticated user cannot see it. Verify all path identifiers are correct before retrying.

• Changed content type : application/problem+json

DELETE /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments/{commentId}/reply/{replyId}

Parameters:

Changed: spaceId in path

The unique identifier of the workspace space that contains the item.
Changed: workspaceContentId in path
The unique identifier of the workspace item the reply belongs to.
Changed: workspaceVersionId in path
The unique identifier of the workspace item version the comment belongs to.
Changed: commentId in path
The unique identifier of the parent comment whose reply will be deleted.
Changed: replyId in path
The unique identifier of the reply to delete.

Return Type:

Changed response : 401 Unauthorized

Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

• Changed content type : application/problem+json
  Changed response : 403 Forbidden

  Forbidden - the authenticated user lacks permission to delete this reply. Only the reply author or users with manage permission on the item may delete it.

• Changed content type : application/problem+json
  Changed response : 404 Not Found

  Not Found - the specified reply does not exist or the authenticated user cannot see it. Verify both commentId and replyId are correct before retrying.

• Changed content type : application/problem+json

PUT /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments/{commentId}/resolve

Parameters:

Changed: spaceId in path

The unique identifier of the workspace space that contains the item.
Changed: workspaceContentId in path
The unique identifier of the workspace item the comment belongs to.
Changed: workspaceVersionId in path
The unique identifier of the workspace item version the comment belongs to.
Changed: commentId in path
The unique identifier of the comment to mark as resolved.

Return Type:

Changed response : 401 Unauthorized

Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

• Changed content type : application/problem+json
  Changed response : 403 Forbidden

  Forbidden - the authenticated user lacks permission to resolve this comment. Verify the seismic.workspace.manage scope is granted and that the user has manage permission on the item before retrying.

• Changed content type : application/problem+json
  Changed response : 404 Not Found

  Not Found - the specified comment does not exist or the authenticated user cannot see it. Verify all path identifiers are correct before retrying.

• Changed content type : application/problem+json

POST /integration/v2/workspace/urls

Request:

Changed content type : application/json
New optional properties:

• name
• parentFolderId
• url

• Changed property parentFolderId (string)

  UUID of the parent folder where the URL item will be created. Use "root" to create it at the user's root level.

• Changed property url (object)

  Object wrapping the actual web address the URL item should point to.

  • Changed property url (string -> string)

    The fully-qualified HTTP or HTTPS web address that the URL item points to.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property applicationUrls (array)

    List of application-specific URLs for opening the URL item in Seismic.
    Changed items (object):

    • Changed property name (string)

      Display name of the Seismic application context (e.g., 'Default') where this URL opens the item.

GET /integration/v2/workspace/folders/{workspaceContentId}/items

Parameters:

Changed: workspaceContentId in path

The unique identifier of the folder whose items to list. Use "root" to list the user's root folder contents.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property items (array)

    Array of items (files, folders, URLs) contained within the requested folder. Empty when the folder has no contents.
    Changed items (object):
    A single entry in the folder listing; can represent a file, folder, or URL item.

    • Changed property applicationUrls (array)

      List of application-specific URLs for opening this item in Seismic.

• Changed content type : text/plain
  • Changed property items (array)

    Array of items (files, folders, URLs) contained within the requested folder. Empty when the folder has no contents.
    Changed items (object):
    A single entry in the folder listing; can represent a file, folder, or URL item.

    • Changed property applicationUrls (array)

      List of application-specific URLs for opening this item in Seismic.

POST /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments

Parameters:

Changed: spaceId in path

The unique identifier of the workspace space that contains the item.
Changed: workspaceContentId in path
The unique identifier of the workspace item to add a comment to.
Changed: workspaceVersionId in path
The unique identifier of the workspace item version to associate the comment with.

Return Type:

Changed response : 400 Bad Request

Bad Request - the comment body is malformed (invalid annotation, missing text, bad @mention syntax, or unescaped braces). Validate the payload against the operation schema before retrying.

• Changed content type : application/problem+json
  Changed response : 401 Unauthorized

  Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

• Changed content type : application/problem+json
  Changed response : 403 Forbidden

  Forbidden - the authenticated user lacks permission to comment on this item. Verify the seismic.workspace.manage scope is granted and that the user has comment permission on the item before retrying.

• Changed content type : application/problem+json
  Changed response : 404 Not Found

  Not Found - the specified space, item, or version does not exist or the authenticated user cannot see it. Verify the spaceId, workspaceContentId, and workspaceVersionId are correct before retrying.

• Changed content type : application/problem+json

GET /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/comments

Parameters:

Changed: versionId in query

Workspace content version identifier; filters comments to the specified version only.
Changed: offset in query
Number of records to skip for pagination; defaults to 0.
Changed: limit in query
Maximum number of comment records to return per page; defaults to 40.
Changed: spaceId in path
The unique identifier of the workspace space that contains the item.
Changed: workspaceContentId in path
The unique identifier of the workspace item whose comments to retrieve.

Return Type:

Changed response : 401 Unauthorized

Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

• Changed content type : application/problem+json
  Changed response : 403 Forbidden

  Forbidden - the authenticated user lacks permission to view comments on this item. Verify the required scope is granted and that the user has access to the workspace item before retrying.

• Changed content type : application/problem+json
  Changed response : 404 Not Found

  Not Found - the specified space or workspace item does not exist or the authenticated user cannot see it. Verify the spaceId and workspaceContentId are correct before retrying.

• Changed content type : application/problem+json

Result

---

API changes broke backward compatibility

---

Workspace

Link to the documentation

Workspace (v v1)

---

What's Changed

---

GET /workspace/v1/files/{workspaceContentId}/customProperties

Parameters:

Changed: workspaceContentId in path

UUID of the workspace file resource. Use the content ID returned by workspace file listing APIs to fetch its associated DocCenter custom properties.

POST /workspace/v1/items/{workspaceContentId}/members

Parameters:

Changed: workspaceContentId in path

UUID of the workspace file or folder to which you are adding a collaborator. The authenticated user must have seismic.workspace.manage permission on this item.

Request:

Changed content type : application/json
New optional properties:

• id
• role

• Changed property id (string -> string)

  User ID of the person to invite as a collaborator on this workspace file or folder. Must be a valid active Seismic user ID.

• Changed property role (string)

  Permission level for the member: Manager grants full edit and view access to the workspace item; Viewer grants view-only access without editing rights.
  Removed enum values:

  • Manager
  • Viewer

DELETE /workspace/v1/items/{workspaceContentId}/members/{memberId}

Parameters:

Changed: workspaceContentId in path

UUID of the workspace file or folder from which the member's access is being revoked. The authenticated user must have seismic.workspace.manage permission on this item.
Changed: memberId in path
UUID of the member (user ID) whose access permissions are being removed from the workspace item. Obtain this ID from the member listing or Add Member response.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Changed property removedMemberId (string -> string)

    UUID of the user whose access was revoked; matches the memberId provided in the path parameter.

PUT /workspace/v1/items/{workspaceContentId}/owner

Parameters:

Changed: workspaceContentId in path

UUID of the workspace file or folder for which ownership is being transferred. Only the current owner can initiate a transfer; the authenticated user must be the current owner of this item.

Request:

Changed content type : application/json
New optional properties:

• ownerId

• Changed property ownerId (string -> string)

  User ID of the collaborator to transfer ownership to; must be an existing member of the content before the transfer can be initiated.

Return Type:

Changed response : 200 OK

OK

• New content type : text/plain
• Deleted content type : application/json
  Changed response : 400 Bad Request

  Bad Request

• New content type : text/plain
• Deleted content type : application/problem+json
  Changed response : 404 Not Found

  Not Found

• New content type : text/plain
• Deleted content type : application/problem+json

GET /workspace/v1/files/{workspaceContentId}/versions

Parameters:

Deleted: limit in query

Maximum number of version records to return per page. Use with offset for paginated traversal of large version histories. Defaults to 100 if not specified.
Deleted: offset in query
Zero-based index of the first version record to return. Use with limit to paginate through all versions; combine offset=0 with limit=100 to get the first 100 versions.
Changed: workspaceContentId in path
UUID of the workspace file resource. Use the content ID returned by file listing APIs to retrieve version history for that specific file.

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  • Deleted property total (integer)

    Total number of version records available for this workspace file across all pages; use with limit and offset to paginate results.

  • Deleted property limit (integer)

    Maximum number of version records returned in this response page; reflects the limit query parameter value applied to the request.

  • Deleted property offset (integer)

    Zero-based index of the first version record in this response page; reflects the offset query parameter value applied to the request.

Result

---

API changes broke backward compatibility