Optional parameter to include additional information in the response. Note: Now it only supports including space names that the schema is distributed to. Note: The space names will be included in the response under the schema item.
Changed: id in path
(Required) The schema id, which identifies a schema across all versions. Note: This is not the version id, which identifies a specific version of the schema.
Changed: version in path
(Required) The version number, which is a combination of major, minor and tag. Note: The version number is in format of {major}.{minor}, where major and minor are integers. E.g. 1.0, 2.1.
Return Type:
Changed response : 400 Bad Request
Bad Request, meaning the request is invalid. Ensure the schema ID and version number are properly formatted and all required parameters are included in the request.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 401 Unauthorized
Unauthorized, meaning the request is not authorized. Ensure you have a valid tenant-level JWT token to access this endpoint.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 403 Forbidden
Forbidden, meaning you don't have permission to access this resource. Ensure your JWT token has the necessary permissions to access this endpoint.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 404 Not Found
Not Found, meaning the requested resource could not be found. Ensure the schema ID and version number are correct.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 500 Internal Server Error
Internal Server Error, meaning an unexpected error occurred on the server side.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 200 OK
A schema at the given version is successfully retrieved, with space names included if requested. Note: If the specified version does not exist, a 404 Not Found error will be returned
Changed content type : application/json
Changed property tenantId (string -> string)
The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.
Changed property name (string)
The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.
Changed property description (string)
A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.
Changed property spaceIds (array)
The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
Changed items (string -> string):
Changed property version (object)
The version details of this schema, including major and minor version number and whether this is the latest version.
Changed property createdAt (string)
The ISO 8601 timestamp recording when this schema was first created in the system.
Changed property updatedAt (string)
The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.
Changed property spaces (array)
The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
Changed items (object):
Changed property id (string -> string)
The unique identifier of the Seismic space that this schema is distributed to.
Changed property name (string)
The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.
Changed property fields (array)
The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
Changed items (object):
Changed property name (string)
The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.
GET /v1/schemas
Parameters:
Changed: spaceIds in query
List of spaces that this schema is distributed to. Note: A schema can be distributed to multiple spaces, and filtering by spaceIds will return all schemas that are distributed to any of the specified spaces.
Changed: name in query
Name of the schema, supports case insensitive partial match. Note: Filtering by name will return all schemas that match the specified name.
Changed: filter in query
Advanced filter to query all details of Schemas. Note: This field will overwrite SpaceIds, Status, and Name filters.
Changed: limit in query
(Required) The limit of how many schemas get returned, used for pagination. Note: The default limit is 100, if the value is skipped in the query parameter, it will be treated as 100.
Changed: skip in query
(Required) How many schemas to skip from query, used together with limit for pagination. Note: For the first page, skip should be 0, and for the second page, skip should be the same as limit, and so on.
Changed: orderDirection in query
Order direction of the returned schemas, which can be ascending or descending. Note: This will work together with orderBy to order the returned schemas by the specified schema property in either ascending or descending order.
Changed: orderBy in query
Order by which schema property, now it only support ordering by name. Note: This will work together with orderDirection to order the returned schemas by the specified schema property in either ascending or descending order.
Changed: include in query
If the response should include space names that the schema is distributed to. Note: This will not return the full space details, only the id and name. Note: The space names will be included in the response under each schema item.
Return Type:
Changed response : 401 Unauthorized
Unauthorized to access the resource. Ensure you have a valid tenant-level JWT token.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 403 Forbidden
Forbidden to access the resource. Ensure your JWT token has the necessary permissions to access this endpoint.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 200 OK
Successfully retrieved the custom schemas, with space names included if requested.
Changed content type : application/json
Changed property count (number)
The number of custom schemas returned in this page of results, which may be less than limit if fewer results are available.
Changed property totalCount (number)
The total number of custom schemas that match the filter criteria across all pages, used to calculate total pages for pagination.
Changed property items (array)
The list of custom schemas that match the filter criteria and pagination settings in this response page.
Changed items (object):
Changed property tenantId (string -> string)
The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.
Changed property name (string)
The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.
Changed property description (string)
A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.
Changed property spaceIds (array)
The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
Changed items (string -> string):
Changed property version (object)
The version details of this schema, including major and minor version number and whether this is the latest version.
Changed property createdAt (string)
The ISO 8601 timestamp recording when this schema was first created in the system.
Changed property updatedAt (string)
The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.
Changed property spaces (array)
The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
Changed items (object):
Changed property id (string -> string)
The unique identifier of the Seismic space that this schema is distributed to.
Changed property name (string)
The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.
Changed property fields (array)
The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
Changed items (object):
Changed property name (string)
The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.
POST /v1/schemas
Request:
Changed content type : application/json
Changed property name (string)
The name of the schema to be created, which is required and must be unique across the tenant, a duplicated name will result in a Bad Request error.
Changed property description (string)
The description of the schema to be created, which is optional. If not provided, it will be defaulted to an empty string.
Changed property spaceIds (array)
The IDs of the spaces where the schema will be distributed. If not provided, the schema will not be distributed to any space. Note: ShortGuid of the space can also be used and the system will convert it to spaceId automatically.
Changed items (string -> string):
Changed property fields (array)
The fields of the schema to be created, which is required and must have at least one item and at most 200 items. Note: no null values are allowed in the fields array.
Return Type:
Changed response : 400 Bad Request
Bad Request - The request body is invalid or missing required fields. Ensure that the JSON is properly formatted and includes all necessary information.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 401 Unauthorized
Unauthorized
New content type : application/problem+json
Deleted content type : application/json
Changed response : 403 Forbidden
Forbidden
New content type : application/problem+json
Deleted content type : application/json
Changed response : 404 Not Found
Not Found
New content type : application/problem+json
Deleted content type : application/json
Changed response : 500 Internal Server Error
Internal Server Error
New content type : application/problem+json
Deleted content type : application/json
Changed response : 201 Created
Successfully created a new schema with the provided name, description and fields details, and distributed it to the specified spaces if spaceIds are provided.
Changed content type : application/json
Changed property tenantId (string -> string)
The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.
Changed property name (string)
The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.
Changed property description (string)
A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.
Changed property spaceIds (array)
The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
Changed items (string -> string):
Changed property version (object)
The version details of this schema, including major and minor version number and whether this is the latest version.
Changed property createdAt (string)
The ISO 8601 timestamp recording when this schema was first created in the system.
Changed property updatedAt (string)
The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.
Changed property spaces (array)
The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
Changed items (object):
Changed property id (string -> string)
The unique identifier of the Seismic space that this schema is distributed to.
Changed property name (string)
The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.
Changed property fields (array)
The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
Changed items (object):
Changed property name (string)
The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.
DELETE /v1/schemas/{id}
Parameters:
Changed: id in path
(Required) The schema id, which identifies a schema across all versions. Note: This is not the version id, which identifies a specific version of the schema.
Return Type:
Changed response : 204 No Content
No Content, which means the schema is successfully deleted.
Deleted content type : text/plain
Changed response : 400 Bad Request
Bad Request, which means the request is invalid. Ensure the schema ID is properly formatted and all required parameters are included in the request.
New content type : application/problem+json
Deleted content type : text/plain
Changed response : 401 Unauthorized
Unauthorized, which means the request lacks valid authentication credentials. Ensure a valid JWT token is provided.
New content type : application/problem+json
Deleted content type : text/plain
Changed response : 403 Forbidden
Forbidden, which means you don't have permission to access this resource. Ensure your JWT token has the necessary permissions to access this endpoint.
New content type : application/problem+json
Deleted content type : text/plain
Changed response : 404 Not Found
Not Found, which means the specified schema could not be found. Ensure the schema ID is correct and the schema exists.
New content type : application/problem+json
Deleted content type : text/plain
Changed response : 500 Internal Server Error
Internal Server Error, which means an unexpected error occurred on the server. Ensure the server is functioning correctly and try again later.
New content type : application/problem+json
Deleted content type : text/plain
GET /v1/schemas/{id}
Parameters:
Changed: include in query
Optional parameter to include additional information in the response. Note: Now it only supports including space names that the schema is distributed to. The space names will be included in the response under the schema item.
Changed: id in path
(Required) The schema id, which identifies a schema across all versions. Note: This is not the version id, which identifies a specific version of the schema.
Return Type:
Changed response : 400 Bad Request
Bad Request, means the request is invalid. Ensure the schema ID is properly formatted and all required parameters are included in the request.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 401 Unauthorized
Unauthorized, means the request is not authorized. Ensure you have a valid tenant-level JWT token to access this endpoint.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 403 Forbidden
Forbidden, means you don't have permission to access this resource. Ensure your JWT token has the necessary permissions to access this endpoint.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 404 Not Found
Not Found, means the requested schema could not be found. Ensure the schema ID is correct and the schema exists.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 500 Internal Server Error
Internal Server Error
New content type : application/problem+json
Deleted content type : application/json
Changed response : 200 OK
OK, means successfully retrieved the latest version of the schema by the given id, with space names included if requested.
Changed content type : application/json
Changed property tenantId (string -> string)
The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.
Changed property name (string)
The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.
Changed property description (string)
A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.
Changed property spaceIds (array)
The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
Changed items (string -> string):
Changed property version (object)
The version details of this schema, including major and minor version number and whether this is the latest version.
Changed property createdAt (string)
The ISO 8601 timestamp recording when this schema was first created in the system.
Changed property updatedAt (string)
The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.
Changed property spaces (array)
The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
Changed items (object):
Changed property id (string -> string)
The unique identifier of the Seismic space that this schema is distributed to.
Changed property name (string)
The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.
Changed property fields (array)
The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
Changed items (object):
Changed property name (string)
The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.
PUT /v1/schemas/{id}
Parameters:
Changed: id in path
(Required) The schema id, which identifies a schema across all versions. Note: This is not the version id, which identifies a specific version of the schema.
Request:
Changed content type : application/json
Changed property name (string)
The name of the schema to be created, which is required and must be unique across the tenant, a duplicated name will result in a Bad Request error.
Changed property description (string)
The description of the schema to be created, which is optional. If not provided, it will be defaulted to an empty string.
Changed property spaceIds (array)
The IDs of the spaces where the schema will be distributed. If not provided, the schema will not be distributed to any space. Note: ShortGuid of the space can also be used and the system will convert it to spaceId automatically.
Changed items (string -> string):
Changed property fields (array)
The fields of the schema to be created, which is required and must have at least one item and at most 200 items. Note: no null values are allowed in the fields array.
Return Type:
Changed response : 400 Bad Request
Bad Request, means the request is invalid. Ensure the schema ID is properly formatted, the request body is valid and includes all required fields.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 401 Unauthorized
Unauthorized, meaning the request is not authorized. Ensure you have a valid tenant-level JWT token to access this endpoint.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 403 Forbidden
Forbidden, means you don't have permission to access this resource. Ensure your JWT token has the necessary permissions to access this endpoint.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 404 Not Found
Not Found, meaning the requested schema could not be found. Ensure the schema ID is correct and the schema exists.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 500 Internal Server Error
Internal Server Error, meaning an unexpected error occurred while processing the request. Ensure the server is functioning properly and try again later.
New content type : application/problem+json
Deleted content type : application/json
Changed response : 200 OK
OK, means the schema is successfully updated, and the updated schema will be returned in the response body.
Changed content type : application/json
Changed property tenantId (string -> string)
The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.
Changed property name (string)
The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.
Changed property description (string)
A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.
Changed property spaceIds (array)
The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
Changed items (string -> string):
Changed property version (object)
The version details of this schema, including major and minor version number and whether this is the latest version.
Changed property createdAt (string)
The ISO 8601 timestamp recording when this schema was first created in the system.
Changed property updatedAt (string)
The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.
Changed property spaces (array)
The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
Changed items (object):
Changed property id (string -> string)
The unique identifier of the Seismic space that this schema is distributed to.
Changed property name (string)
The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.
Changed property fields (array)
The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
Changed items (object):
Changed property name (string)
The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.
Optional list of audit domains to exclude from results. When omitted
or empty, no domains are excluded. When provided, each value must be
a recognized domain name (case-insensitive).
Hierarchy expansion: A parent domain in this list excludes all
its child domains as well. For example, "Security & Permissions / Privacy Management" also excludes all Privacy Management sub-domains.
Exclusion precedence: If the same domain appears in both auditDomains and ignoredAuditDomains, it is excluded from results.
Accepts the same valid values as auditDomains.
Items (string):
Added property resourceType (string)
Optional filter to return only records where the target resource type
matches this value (case-sensitive exact match). Whitespace is trimmed.
Added property resourceName (string)
Optional filter to return only records where the target resource name
matches this value (case-sensitive exact match). Whitespace is trimmed.
Added property impersonatedBy (array)
Optional filter to return only records where the action was performed
via impersonation by one of the provided actor IDs.
Items (string):
Changed property auditDomains (array)
Optional filter by audit domain(s). When omitted, records from all
domains are returned. When provided, must contain at least one value
and all values must be recognized domain names (case-insensitive).
Hierarchy expansion: If the specified domain has child domains, it
automatically expands to include all of them. For example, "Security & Permissions" also returns records for "Security & Permissions / SSO Settings", "Security & Permissions / Watermark Templates", and all other
sub-domains. If the specified domain is already a leaf (no children),
only records for that exact domain are returned.
Valid values:
People
Security & Permissions
Security & Permissions / Password Policy
Security & Permissions / Permissions
Security & Permissions / SSO Settings
Security & Permissions / LiveSend Permissions
Security & Permissions / Network Security
Security & Permissions / Certificate Management
Security & Permissions / Privacy Management
Security & Permissions / Privacy Management / Data Privacy Settings
Security & Permissions / Privacy Management / User Data
Optional list of audit domains to exclude from results. When omitted
or empty, no domains are excluded. When provided, each value must be
a recognized domain name (case-insensitive).
Hierarchy expansion: A parent domain in this list excludes all
its child domains as well. For example, "Security & Permissions / Privacy Management" also excludes all Privacy Management sub-domains.
Exclusion precedence: If the same domain appears in both auditDomains and ignoredAuditDomains, it is excluded from results.
Accepts the same valid values as auditDomains.
Items (string):
Added property resourceType (string)
Optional filter to return only records where the target resource type
matches this value (case-sensitive exact match). Whitespace is trimmed.
Added property resourceName (string)
Optional filter to return only records where the target resource name
matches this value (case-sensitive exact match). Whitespace is trimmed.
Added property impersonatedBy (array)
Optional filter to return only records where the action was performed
via impersonation by one of the provided actor IDs.
Items (string):
Changed property auditDomains (array)
Optional filter by audit domain(s). When omitted, records from all
domains are returned. When provided, must contain at least one value
and all values must be recognized domain names (case-insensitive).
Hierarchy expansion: If the specified domain has child domains, it
automatically expands to include all of them. For example, "Security & Permissions" also returns records for "Security & Permissions / SSO Settings", "Security & Permissions / Watermark Templates", and all other
sub-domains. If the specified domain is already a leaf (no children),
only records for that exact domain are returned.
Valid values:
People
Security & Permissions
Security & Permissions / Password Policy
Security & Permissions / Permissions
Security & Permissions / SSO Settings
Security & Permissions / LiveSend Permissions
Security & Permissions / Network Security
Security & Permissions / Certificate Management
Security & Permissions / Privacy Management
Security & Permissions / Privacy Management / Data Privacy Settings
Security & Permissions / Privacy Management / User Data
POST /v3/teamsites/{teamsiteId}/livedocTemplates/generate
Submit LiveDoc generation from uploaded template
What's Changed
GET /v3/generatedLivedocs/{generatedLivedocId}/outputs/{outputId}/content
Download a Document Generator output
Return Type:
Changed response : 404 Not Found
Content is not found or not ready for download.
Changed content type : application/json
GET /v3/generatedLivedocs/{generatedLivedocId}
Get status of Document Generator process
GET /v3/teamsites/{teamSiteId}/livedocVersions/{libraryContentVersionId}
Get the list of inputs for a Document Generator
POST /v3/teamsites/{teamSiteId}/livedocVersions/{libraryContentVersionId}
Run a Document Generator
Parameters:
Changed: teamSiteId in path
Team site identifier that owns the livedoc template version.
Changed: libraryContentVersionId in path
Content version identifier of the livedoc template.
Return Type:
Changed response : 201 Created
Generation request created successfully.
Changed header : Location
URL of the generated Livedoc status resource.
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:
New 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.
New 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.
New 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 response : 204 No Content
No Content - the comment and all its replies were successfully deleted.
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:
New 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.
New 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.
New 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 response : 204 No Content
No Content - the reply was successfully deleted.
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:
New 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.
New 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.
New 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 response : 204 No Content
No Content - the comment was successfully marked as resolved.
POST /integration/v2/workspace/folders
Parameters:
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
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.
Changed property name (string)
The display name for the new folder. Must be unique within the parent folder.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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 response : 201 Created
Created
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the newly created workspace folder, in UUID format.
Changed property type (string)
The content type of this item; either "folder" for standard folders or "rootFolder" for the user's root folder.
Changed property repository (string)
The repository where this item resides; for workspace items this is always "workspace".
Changed property resourceUrl (string)
The fully-qualified REST API URL to access this folder resource directly.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when this folder was originally created.
Changed property createdBy (object)
Information about the user who created this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
ISO 8601 timestamp indicating when this folder was last modified.
Changed property modifiedBy (object)
Information about the user who last modified this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this folder is a contextual folder linked to a CRM entity; true for CRM-linked folders, false for standard folders.
Changed property iconUrl (string)
URL to the icon image representing this folder's visual type in the Seismic UI.
Changed property format (string)
The format identifier for this item; for folders this is always "folder".
Changed property name (string)
The display name of the folder as it appears in the workspace.
Changed property parentFolderId (string)
The unique identifier of the parent folder containing this folder; "root" indicates a top-level folder in the user's root.
Changed property applicationUrls (array)
List of application-specific URLs for accessing this folder in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
POST /integration/v2/workspace/folders/{workspaceFolderId}/copy
Parameters:
Changed: workspaceFolderId in path
The unique identifier of the workspace folder to copy.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
UUID of the destination folder where the folder copy will be placed. Use "root" to copy the folder to the user's root level.
Changed property name (string)
Display name for the copied folder in the destination location. Must be unique within the destination folder.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
The repository where this item resides; for workspace items this is always "workspace".
Changed property id (string)
Unique identifier of the copied folder, in UUID format.
Changed property type (string)
The content type of this item; either "folder" for standard folders or "rootFolder" for the user's root folder.
Changed property name (string)
The display name of the copied folder.
Changed property parentFolderId (string)
The unique identifier of the destination parent folder where the copy was placed.
Changed property resourceUrl (string)
The fully-qualified REST API URL to access this copied folder resource.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when the copied folder was created.
Changed property createdBy (object)
Information about the user who created this copy.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
ISO 8601 timestamp indicating when this folder was last modified.
Changed property modifiedBy (object)
Information about the user who last modified this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this is a CRM-linked contextual folder; false for standard copied folders.
Changed property iconUrl (string)
URL to the icon image representing this folder's visual type.
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', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
POST /integration/v2/workspace/folders/createContextualFolder
Parameters:
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
Changed property systemType (string)
The CRM system type. Supported values are Salesforce, MicrosoftDynamicsCRM, Hubspot, OracleCX. Case-sensitive.
Added enum values:
Salesforce
MicrosoftDynamicsCRM
Hubspot
OracleCX
Changed property contextType (string)
The singular CRM entity type (e.g., "Account", "Opportunity"). Case-sensitive; typos create non-removable folders.
Changed property contextTypePlural (string)
The plural CRM entity type used in the folder path (e.g., "Accounts", "Opportunities"). Case-sensitive.
Changed property contextId (string)
The unique identifier of the CRM entity instance this folder is linked to. Case-sensitive.
Changed property name (string)
The display name for the contextual folder. Typically the CRM entity name for easy identification.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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 response : 200 OK
OK
Changed content type : application/json
Changed property id (string)
Unique identifier of the contextual folder, in UUID format.
Changed property type (string)
The content type of this item; either "folder" for standard folders or "rootFolder" for the user's root folder.
Changed property repository (string)
The repository where this item resides; always "workspace" for workspace items.
Changed property resourceUrl (string)
The fully-qualified REST API URL to access this contextual folder resource.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when this contextual folder was first created.
Changed property createdBy (object)
Information about the user who created this contextual folder.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
ISO 8601 timestamp indicating when this contextual folder was last modified.
Changed property modifiedBy (object)
Information about the user who last modified this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Always true for contextual folders, indicating they are linked to a CRM business entity.
Changed property iconUrl (string)
URL to the icon image representing this contextual folder's visual type.
Changed property format (string)
The format identifier; for folders this is always "folder".
Changed property name (string)
The display name of the contextual folder, typically derived from the CRM context.
Changed property parentFolderId (string)
The unique identifier of the parent folder in the contextual folder hierarchy.
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', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
POST /integration/v2/workspace/files
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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 response : 201 Created
Created
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the newly created workspace file, in UUID format.
Changed property type (string)
The content type of this item; for files this is always "file".
Changed property repository (string)
The repository where this item resides; for workspace items this is always "workspace".
Changed property resourceUrl (string)
The fully-qualified REST API URL to access this file resource directly.
Changed property size (number)
The size of the file in bytes.
Changed property versionId (string)
Unique identifier of the current version of this file, in UUID format.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when this file was originally created in workspace.
Changed property createdBy (object)
Information about the user who uploaded and created this file.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
ISO 8601 timestamp indicating when this file was last modified or a new version was uploaded.
Changed property modifiedBy (object)
Information about the user who last modified this file.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this file is associated with a CRM contextual folder; false for standard workspace files.
Changed property iconUrl (string)
URL to the icon image representing this file's format type in the Seismic UI.
Changed property format (string)
The file format extension (e.g., pptx, pdf, docx) indicating the file type.
Changed property name (string)
The display name of the file as it appears in the workspace.
Changed property parentFolderId (string)
The unique identifier of the parent folder containing this file; "root" indicates the user's root folder.
Changed property deliveryOptions (array)
List of delivery option identifiers available for sharing this file.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace file to delete.
Return Type:
New 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.
New 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.
New 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 response : 200 OK
OK - the workspace file was successfully soft-deleted. The response body is empty.
Changed header : Date
GET /integration/v2/workspace/files/{workspaceContentId}
Parameters:
Changed: workspaceContentId in path
The unique identifier of the workspace file to retrieve information for.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property id (string)
Unique identifier of the workspace file, in UUID format.
Changed property type (string)
Item type discriminator; "file" for file items.
Changed property repository (string)
Repository where the file resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this file resource directly.
Changed property size (number)
Size of the file in bytes.
Changed property versionId (string)
Unique identifier of the current version of the file, in UUID format. Changes whenever a new version is uploaded.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this file was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this file.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this file was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this file.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this file is associated with a CRM contextual folder; false for standard workspace files.
Changed property iconUrl (string)
URL to the icon image representing this file's format type in the Seismic UI.
Changed property format (string)
The file format extension (e.g., "pptx", "pdf", "docx") indicating the file type.
Changed property name (string)
Display name of the file as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this file; "root" indicates the user's root folder.
Changed property deliveryOptions (array)
Array of delivery option references available for sharing this file.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening this file in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace file to update.
Request:
Changed content type : application/json
Changed property name (string)
New display name for the file. Must be unique within the parent folder.
Changed property parentFolderId (string)
UUID of the destination folder to move the file to. Use "root" for the user's root folder.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the updated workspace file, in UUID format.
Changed property type (string)
Item type discriminator; "file" for file items.
Changed property repository (string)
Repository where the file resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this file resource directly.
Changed property size (number)
Size of the file in bytes (unchanged by metadata updates).
Changed property versionId (string)
Unique identifier of the current version of the file, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this file was originally created, in UTC.
Changed property createdBy (object)
Information about the user who originally created this file.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this file was last modified by this update, in UTC.
Changed property modifiedBy (object)
Information about the user who performed this update.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this file is associated with a CRM contextual folder; false for standard workspace files.
Changed property iconUrl (string)
URL to the icon image representing this file's format type in the Seismic UI.
Changed property format (string)
The file format extension (e.g., "pptx", "pdf", "docx") indicating the file type.
Changed property name (string)
Display name of the file after the update.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this file after the update; "root" indicates the user's root folder.
Changed property deliveryOptions (array)
Array of delivery option references available for sharing this file.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening this file in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
Repository where the copy resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the newly created file copy, in UUID format. Different from the source file ID.
Changed property versionId (string)
Unique identifier of the initial version of the copy, in UUID format.
Changed property name (string)
Display name of the copy in the destination folder.
Changed property type (string)
Item type discriminator; "file" for file items.
Changed property size (number)
Size of the copied file in bytes (matches the source file size).
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was created, in UTC.
Changed property createdBy (object)
Information about the user who performed the copy operation.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was last modified, in UTC. Equal to createdAt on creation.
Changed property modifiedBy (object)
Information about the user who last modified the copy.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property parentFolderId (string)
Unique identifier of the destination parent folder where the copy was placed; "root" indicates the user's root folder.
Changed property format (string)
The file format extension (e.g., "pptx", "pdf", "docx") of the copy.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access the copy directly.
Changed property isContextualContent (boolean)
Indicates whether the copy is contextual content linked to a CRM entity; inherited from the destination folder context.
Changed property applicationUrls (array)
List of application-specific URLs for opening the copy in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
Changed property deliveryOptions (array)
Array of delivery option references applicable to the copy.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace 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.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
Success
Changed content type : application/json
Changed property downloadUrl (string)
Pre-signed HTTPS URL to download the file content directly. Valid for a limited time; re-request if expired.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property id (string)
Unique identifier of the workspace file (unchanged across versions), in UUID format.
Changed property type (string)
Item type discriminator; "file" for file items.
Changed property repository (string)
Repository where the file resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this file resource directly.
Changed property size (number)
Size of the newly uploaded version in bytes.
Changed property versionId (string)
Unique identifier of the newly created version, in UUID format. Previous versions remain accessible under their own versionIds.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the file was originally created, in UTC.
Changed property createdBy (object)
Information about the user who originally created the file.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the new version was uploaded, in UTC.
Changed property modifiedBy (object)
Information about the user who uploaded this version.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this file is associated with a CRM contextual folder; false for standard workspace files.
Changed property iconUrl (string)
URL to the icon image representing this file's format type in the Seismic UI.
Changed property format (string)
The file format extension (e.g., "pptx", "pdf", "docx", "txt") of the new version.
Changed property name (string)
Display name of the file as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this file; "root" indicates the user's root folder.
Changed property deliveryOptions (array)
Array of delivery option references available for sharing this file.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening this file in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace URL item to delete.
Return Type:
New 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.
New 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.
New 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 response : 200 OK
OK - the workspace URL item was successfully soft-deleted. The response body is empty.
Changed header : Date
GET /integration/v2/workspace/urls/{workspaceContentId}
Parameters:
Changed: workspaceContentId in path
The unique identifier of the workspace URL item to retrieve.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property url (object)
Object wrapping the actual web address the URL item points to.
Changed property id (string)
Unique identifier of the URL item, in UUID format.
Changed property type (string)
Item type discriminator; "url" for URL items.
Changed property repository (string)
Repository where the URL item resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this URL item resource directly.
Changed property versionId (string)
Unique identifier of the current version of the URL item, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this URL item is contextual content linked to a CRM entity.
Changed property iconUrl (string)
URL to the icon image representing this URL item in the Seismic UI.
Changed property format (string)
Format identifier; typically "url" for URL items.
Changed property name (string)
Display name of the URL item as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this URL item; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to this URL item.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening this URL item in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace URL item to update.
Request:
Changed content type : application/json
Changed property name (string)
New display name for the URL item. Must be unique within the parent folder.
Changed property parentFolderId (string)
UUID of the destination folder to move the URL item to. Use "root" for the user's root folder.
Changed property url (object)
Object wrapping the updated web address the URL item should point to.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property url (object)
Object wrapping the updated web address the URL item points to.
Changed property id (string)
Unique identifier of the URL item, in UUID format.
Changed property type (string)
Item type discriminator; "url" for URL items.
Changed property repository (string)
Repository where the URL item resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this URL item resource directly.
Changed property versionId (string)
Unique identifier of the current version of the URL item, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was last modified by this update, in UTC.
Changed property modifiedBy (object)
Information about the user who performed this update.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this URL item is contextual content linked to a CRM entity.
Changed property iconUrl (string)
URL to the icon image representing this URL item in the Seismic UI.
Changed property format (string)
Format identifier; typically "url" for URL items.
Changed property name (string)
Display name of the URL item after the update.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this URL item after the update; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to this URL item.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening this URL item in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property url (object)
Object wrapping the web address the copied URL item points to. Mirrors the source URL item.
Changed property id (string)
Unique identifier of the newly created URL item copy, in UUID format. Different from the source URL item ID.
Changed property type (string)
Item type discriminator; "url" for URL items.
Changed property repository (string)
Repository where the copy resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access the copied URL item directly.
Changed property versionId (string)
Unique identifier of the initial version of the copy, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was created, in UTC.
Changed property createdBy (object)
Information about the user who performed the copy operation.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was last modified, in UTC. Equal to createdAt on creation.
Changed property modifiedBy (object)
Information about the user who last modified the copy.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether the copy is contextual content linked to a CRM entity.
Changed property iconUrl (string)
URL to the icon image representing the copy in the Seismic UI.
Changed property format (string)
Format identifier; typically "url" for URL items.
Changed property name (string)
Display name of the copy in the destination folder.
Changed property parentFolderId (string)
Unique identifier of the destination parent folder where the copy was placed; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to the copy.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening the copy in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace item (file, folder, or URL) to delete.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
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:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the workspace item, in UUID format.
Changed property type (string)
Item type discriminator; one of "file", "folder", or "url".
Changed property repository (string)
Repository where the item resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this resource directly.
Changed property size (number)
Size of the underlying content in bytes; 0 for folders and URLs that have no binary payload.
Changed property versionId (string)
Unique identifier of the current version of the item, in UUID format. Changes whenever a new version is uploaded.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this item is contextual content linked to a CRM entity; true for CRM-linked items, false otherwise.
Changed property iconUrl (string)
URL to the icon image representing this item's visual type in the Seismic UI.
Changed property format (string)
File format identifier such as "pptx", "pdf", "url", or "folder". Used by clients to decide rendering or download behavior.
Changed property name (string)
Display name of the item as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this item; "root" indicates a top-level item in the user's root.
Changed property deliveryOptions (array)
Array of delivery option references applicable to this item, used to determine how the content can be shared or delivered.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening this item in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace item (file, folder, or URL) to update.
Request:
Changed content type : application/json
Changed property name (string)
New display name for the workspace item.
Changed property parentFolderId (string)
UUID of the destination folder to move the item to. Use "root" for the user's root folder.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the updated workspace item, in UUID format.
Changed property type (string)
Item type discriminator; one of "file", "folder", or "url".
Changed property repository (string)
Repository where the item resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this resource directly.
Changed property size (number)
Size of the underlying content in bytes; 0 for folders and URLs that have no binary payload.
Changed property versionId (string)
Unique identifier of the current version of the item, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was last modified by this update, in UTC.
Changed property modifiedBy (object)
Information about the user who performed this update.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this item is contextual content linked to a CRM entity; true for CRM-linked items, false otherwise.
Changed property iconUrl (string)
URL to the icon image representing this item's visual type in the Seismic UI.
Changed property format (string)
File format identifier such as "pptx", "pdf", "url", or "folder".
Changed property name (string)
Display name of the item after the update.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this item after the update; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to this item.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening this item in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the newly created copy of the workspace item, in UUID format. Different from the source item ID.
Changed property type (string)
Item type discriminator of the copy; one of "file", "folder", or "url". Matches the source item type.
Changed property repository (string)
Repository where the copy resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access the newly created copy directly.
Changed property size (number)
Size of the underlying content in bytes; 0 for folders and URLs that have no binary payload.
Changed property versionId (string)
Unique identifier of the initial version of the copy, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was created, in UTC.
Changed property createdBy (object)
Information about the user who performed the copy operation.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was last modified, in UTC. Equal to createdAt on creation.
Changed property modifiedBy (object)
Information about the user who last modified the copy.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether the copy is contextual content linked to a CRM entity; inherited from the destination folder context.
Changed property iconUrl (string)
URL to the icon image representing the copy's visual type in the Seismic UI.
Changed property format (string)
File format identifier of the copy such as "pptx", "pdf", "url", or "folder".
Changed property name (string)
Display name of the copy in the destination folder.
Changed property parentFolderId (string)
Unique identifier of the destination parent folder where the copy was placed; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to the copy.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property applicationUrls (array)
List of application-specific URLs for opening the copy in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace folder to delete.
Return Type:
New 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.
New response : 403 Forbidden
Forbidden - the authenticated user lacks permission to delete this folder. Verify the seismic.workspace.manage scope is granted and that the user has manage permission on the folder before retrying.
New response : 404 Not Found
Not Found - the requested folder does not exist or the authenticated user cannot see it. Verify the workspaceFolderId is correct and that the folder has not been deleted before retrying.
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.
Deleted header : Cache-Control
Deleted header : Pragma
Deleted header : Transfer-Encoding
Deleted header : X-Content-Type-Options
Deleted header : Strict-Transport-Security
Deleted header : api-supported-versions
Deleted header : Date
New content type : application/problem+json
Deleted content type : application/json
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:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
Repository where the folder resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the workspace folder, in UUID format.
Changed property type (string)
Item type discriminator; "folder" for standard folders or "rootFolder" for the user's root folder.
Changed property name (string)
Display name of the folder as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this folder; "root" indicates a top-level folder in the user's root.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this folder resource directly.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this folder was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this folder was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this folder is a contextual folder linked to a CRM entity; true for CRM-linked folders, false for standard folders.
Changed property iconUrl (string)
URL to the icon image representing this folder's visual type in the Seismic UI.
Changed property applicationUrls (array)
List of application-specific URLs for opening this folder in Seismic web or mobile applications.
The unique identifier of the workspace folder to rename or move.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
Changed property name (string)
New display name for the folder. Must be unique within the parent folder.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
Repository where the folder resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the updated workspace folder, in UUID format.
Changed property type (string)
Item type discriminator; always "folder" for this response.
Changed property name (string)
Display name of the folder after the update.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this folder after the update; "root" indicates a top-level folder.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this folder resource directly.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this folder was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this folder was last modified by this update, in UTC.
Changed property modifiedBy (object)
Information about the user who performed this update.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this folder is a contextual folder linked to a CRM entity; true for CRM-linked folders, false otherwise.
Changed property iconUrl (string)
URL to the icon image representing this folder's visual type in the Seismic UI.
Changed property applicationUrls (array)
List of application-specific URLs for opening this folder in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
GET /integration/v2/workspace/{workspaceContentId}/members
Parameters:
Changed: workspaceContentId in path
The unique identifier of the workspace item whose member list to retrieve.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed items (object):
Changed property id (string)
Unique identifier of the member user, in UUID format.
Changed property name (string)
The full display name of the collaborator as it appears in Seismic.
Changed property email (string)
The email address of the collaborator used for login and notifications.
Changed property role (string)
The permission role of this member on the item, such as viewer or editor.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when this member was added to the item.
GET /integration/v2/users/recents
Return Type:
Changed response : 200 OK
OK
Changed content type : application/json
Changed items (object):
Changed property modifiedAt (string -> string)
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.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Return Type:
New 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.
New 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.
New 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.
New 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 response : 200 OK
OK
Changed content type : application/json
Changed property createdAt (string -> string)
POST /integration/v2/workspace/urls
Parameters:
Changed: openInNewWindow in query
When true, the URL opens in a new browser window; when false it opens in the current window.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
New required properties:
name
parentFolderId
url
Changed property name (string)
Display name for the new URL item as it will appear in the workspace.
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.
Changed property description (string)
Optional human-readable description shown alongside the URL item in the workspace UI.
Changed property thumbnail (string)
Optional base64 data URI for a custom thumbnail image; if omitted, a default icon is used.
Changed property mode (string)
Controls how the URL item is rendered when opened in a Seismic application.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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 response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
Repository where the URL item resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the newly created URL item, in UUID format.
Changed property versionId (string)
Unique identifier of the initial version of the URL item, in UUID format.
Changed property name (string)
Display name of the URL item as it appears in the workspace.
Changed property type (string)
Item type discriminator; always "file" for URL items in workspace.
Changed property size (number)
Size of the underlying content in bytes; typically 0 or small for URL items.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was created, in UTC.
Changed property createdBy (object)
Information about the user who created the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing the URL item; "root" indicates a top-level item.
Changed property format (string)
Format identifier of the item; typically "url" for URL items.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access the URL item resource directly.
Changed property isContextualContent (boolean)
Indicates whether this URL item is contextual content linked to a CRM entity.
Changed property iconUrl (string)
URL to the icon image representing the URL item in the Seismic UI.
Changed property applicationUrls (array)
List of application-specific URLs for opening the URL item in Seismic web or mobile applications.
Changed items (object):
Changed property name (string)
Display name of the Seismic application context (e.g., 'Default', 'Mobile') where this URL opens the item.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
Changed property deliveryOptions (array)
Array of delivery option references applicable to the URL item.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property content (array)
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:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property itemCount (number -> integer)
Total number of items returned in the items array. When recursive=true this counts all nested items, not just direct children.
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 repository (string)
Repository where the item resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the workspace item, in UUID format.
Changed property type (string)
Item type discriminator; one of "file", "folder", or "url".
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this item directly.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this item is contextual content linked to a CRM entity.
Changed property name (string)
Display name of the item as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this item; matches the workspaceContentId of the folder being listed.
Changed property applicationUrls (array)
List of application-specific URLs for opening this item in Seismic web or mobile applications.
Changed content type : text/plain
Changed property itemCount (number -> integer)
Total number of items returned in the items array. When recursive=true this counts all nested items, not just direct children.
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 repository (string)
Repository where the item resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the workspace item, in UUID format.
Changed property type (string)
Item type discriminator; one of "file", "folder", or "url".
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this item directly.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this item is contextual content linked to a CRM entity.
Changed property name (string)
Display name of the item as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this item; matches the workspaceContentId of the folder being listed.
Changed property applicationUrls (array)
List of application-specific URLs for opening this item in Seismic web or mobile applications.
GET /integration/v2/users/{userId}
Return Type:
Changed response : 200 OK
OK
Changed content type : application/json
Changed property createdAt (string -> string)
GET /integration/v2/users/profiles
Return Type:
Changed response : 200 OK
OK
Changed content type : application/json
Changed items (object):
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.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
Return Type:
New 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.
New 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.
New 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.
New 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 response : 200 OK
OK
Changed content type : application/json
Changed property createdAt (string -> string)
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:
New 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.
New 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.
New 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 response : 200 OK
OK
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 required 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.
Added enum values:
Manager
Viewer
Return Type:
New response : 400 Bad Request
Bad Request
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 404 Not Found
Not Found
New response : 409 Conflict
Conflict
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
Changed content type : application/json
Changed property id (string -> string)
User ID of the member who was added as a collaborator; equivalent to the id field supplied in the request body.
Changed property name (string)
Display name of the user who was added as a collaborator on this workspace item.
Changed property email (string)
Email address of the user who was added as a collaborator on this workspace item.
Changed property role (string)
Permission role granted to the member: Manager allows edit and view access; Viewer allows view-only access.
Added enum values:
Manager
Viewer
Changed property createdAt (string -> string)
RFC 3339 UTC timestamp indicating when the member was added to this workspace content (e.g., 2025-07-16T00:00:00Z).
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:
New response : 400 Bad Request
Bad Request
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 404 Not Found
Not Found
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
New content type : application/json
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 required 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:
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
New content type : application/json
Deleted content type : text/plain
Changed response : 400 Bad Request
Bad Request
New content type : application/problem+json
Deleted content type : text/plain
Changed response : 404 Not Found
Not Found
New content type : application/problem+json
Deleted content type : text/plain
GET /workspace/v1/files/{workspaceContentId}/customProperties
Parameters:
Changed: includeInvisibledInDC in query
Controls property visibility filter: true returns all properties including those hidden in DocCenter (Seismic's content library portal); false (default) returns only visible properties. Use true when auditing all configured properties on a file.
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.
Return Type:
New response : 400 Bad Request
Bad Request
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 404 Not Found
Not Found
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
Changed content type : application/json
Changed property properties (array)
List of custom properties associated with the workspace file, sourced from DocCenter configuration.
Changed items (object):
Changed property id (string -> string)
Unique identifier of the custom property definition configured in DocCenter (Seismic's content library portal); use this as the property reference key for update operations.
Changed property name (string)
Display name of the custom property as it appears in DocCenter content views.
Changed property values (array)
List of string values currently assigned to this custom property for the workspace file.
Changed property isVisibleInDocCenter (boolean)
Indicates whether this custom property is visible to users browsing content in DocCenter (Seismic's content library portal).
Indicates whether this property appears as a filter option when browsing or searching in DocCenter (Seismic's content library portal).
Changed property orderIndex (number)
Numeric index controlling the display order of this property relative to others in DocCenter views; lower values appear first.
GET /workspace/v1/files/{workspaceContentId}/versions
Parameters:
Added: 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.
Added: 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:
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 500 Internal Server Error
Internal Server Error
Changed response : 404 Not Found
Not Found
New content type : application/problem+json
Deleted content type : application/json
Changed response : 200 OK
OK
Changed content type : application/json
Added property total (integer)
Total number of version records available for this workspace file across all pages; use with limit and offset to paginate results.
Added property limit (integer)
Maximum number of version records returned in this response page; reflects the limit query parameter value applied to the request.
Added 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.
Changed property id (string -> string)
Unique identifier of the workspace content file, equivalent to the workspaceContentId path parameter. Use this value as workspaceContentId in subsequent API calls.
Changed property name (string)
Display name of the workspace content file as shown in the workspace.
Changed property versions (array)
Ordered list of all version records returned for this page of the workspace content file's version history.
Changed items (object):
Changed property id (string -> string)
Unique identifier of this specific file version record, equivalent to versionId. Use this value when referencing a specific version in version-related operations.
Changed property version (integer)
Sequential version number starting from 1, Incremental after each new version.
Changed property createdBy (string -> string)
User ID of the person who created or uploaded this file version.
Changed property createdAt (string -> string)
RFC 3339 UTC timestamp indicating when this version was created or uploaded; all timestamps are in UTC (e.g., 2025-07-16T00:00:00Z).
Changed property versionCreationMethod (string)
Indicates how this file version was created; for example Upload means a direct file upload, Copy means duplicated from another file, OneDrive Sync or Google Sync means synced from cloud storage.
Added enum values:
UNKNOWN
LiveSend
Add to Cart
Add to MeetingSpace
Copy
Save to Workspace
Record
Freestyle
Guided Assembly
LiveDoc Generated
LiveDoc Iteration
Automatic Update
Upload
Revert to PPT
Convert to PDF
Restore
Edit With Office Online
OneDrive Sync
Google Sync
Meeting Recording
Changed property sourceContent (object)
Changed property contentId (string -> string)
Workspace content ID of the source file from which this version was copied.
Changed property versionId (string -> string)
Version ID of the specific source file version that was copied to create this version.
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.
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.
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.
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.
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.
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.
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.
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:
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.
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.
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:
New 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.
New 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.
New 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 response : 204 No Content
No Content - the comment and all its replies were successfully deleted.
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:
New 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.
New 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.
New 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 response : 204 No Content
No Content - the reply was successfully deleted.
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:
New 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.
New 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.
New 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 response : 204 No Content
No Content - the comment was successfully marked as resolved.
POST /integration/v2/workspace/folders
Parameters:
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
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.
Changed property name (string)
The display name for the new folder. Must be unique within the parent folder.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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 response : 201 Created
Created
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the newly created workspace folder, in UUID format.
Changed property type (string)
The content type of this item; Here, it is always the "folder"
Changed property repository (string)
The repository where this item resides; for workspace items this is always "workspace".
Changed property resourceUrl (string)
The fully-qualified REST API URL to access this folder resource directly.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when this folder was originally created.
Changed property createdBy (object)
Information about the user who created this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
ISO 8601 timestamp indicating when this folder was last modified.
Changed property modifiedBy (object)
Information about the user who last modified this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this folder is a contextual folder linked to a CRM entity; true for CRM-linked folders, false for standard folders.
Changed property iconUrl (string)
URL to the icon image representing this folder's visual type in the Seismic UI.
Changed property format (string)
The format identifier for this item; for folders this is always "folder".
Changed property name (string)
The display name of the folder as it appears in the workspace.
Changed property parentFolderId (string)
The unique identifier of the parent folder containing this folder; "root" indicates a top-level folder in the user's root.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
POST /integration/v2/workspace/folders/{workspaceFolderId}/copy
Parameters:
Changed: workspaceFolderId in path
The unique identifier of the workspace folder to copy.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
Changed property parentFolderId (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.
Changed property name (string)
Display name for the copied folder in the destination location. Must be unique within the destination folder.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
The repository where this item resides; for workspace items this is always "workspace".
Changed property id (string)
Unique identifier of the copied folder, in UUID format.
Changed property type (string)
The content type of this item; Here, it is always the "folder"
Changed property name (string)
The display name of the copied folder.
Changed property parentFolderId (string)
The unique identifier of the destination parent folder where the copy was placed.
Changed property resourceUrl (string)
The fully-qualified REST API URL to access this copied folder resource.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when the copied folder was created.
Changed property createdBy (object)
Information about the user who created this copy.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
ISO 8601 timestamp indicating when this folder was last modified.
Changed property modifiedBy (object)
Information about the user who last modified this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this is a CRM-linked contextual folder; false for standard copied folders.
Changed property iconUrl (string)
URL to the icon image representing this folder's visual type.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
POST /integration/v2/workspace/folders/createContextualFolder
Parameters:
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
Changed property systemType (string)
The CRM system type. Supported values are Salesforce, MicrosoftDynamicsCRM, Hubspot, OracleCX. Case-sensitive.
Changed property contextType (string)
The singular CRM entity type (e.g., "Account", "Opportunity"). Case-sensitive; typos create non-removable folders.
Changed property contextTypePlural (string)
The plural CRM entity type used in the folder path (e.g., "Accounts", "Opportunities"). Case-sensitive.
Changed property contextId (string)
The unique identifier of the CRM entity instance this folder is linked to. Case-sensitive.
Changed property name (string)
The display name for the contextual folder. Typically the CRM entity name for easy identification.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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 response : 200 OK
OK
Changed content type : application/json
Changed property id (string)
Unique identifier of the contextual folder, in UUID format.
Changed property type (string)
The content type of this item; Here, it is always the "folder"
Changed property repository (string)
The repository where this item resides; always "workspace" for workspace items.
Changed property resourceUrl (string)
The fully-qualified REST API URL to access this contextual folder resource.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when this contextual folder was first created.
Changed property createdBy (object)
Information about the user who created this contextual folder.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
ISO 8601 timestamp indicating when this contextual folder was last modified.
Changed property modifiedBy (object)
Information about the user who last modified this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Always true for contextual folders, indicating they are linked to a CRM business entity.
Changed property iconUrl (string)
URL to the icon image representing this contextual folder's visual type.
Changed property format (string)
The format identifier; for folders this is always "folder".
Changed property name (string)
The display name of the contextual folder, typically derived from the CRM context.
Changed property parentFolderId (string)
The unique identifier of the parent folder in the contextual folder hierarchy.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
POST /integration/v2/workspace/files
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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 response : 201 Created
Created
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the newly created workspace file, in UUID format.
Changed property type (string)
The content type of this item; for files this is always "file".
Changed property repository (string)
The repository where this item resides; for workspace items this is always "workspace".
Changed property resourceUrl (string)
The fully-qualified REST API URL to access this file resource directly.
Changed property size (number)
The size of the file in bytes.
Changed property versionId (string)
Unique identifier of the current version of this file, in UUID format.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when this file was originally created in workspace.
Changed property createdBy (object)
Information about the user who uploaded and created this file.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
ISO 8601 timestamp indicating when this file was last modified or a new version was uploaded.
Changed property modifiedBy (object)
Information about the user who last modified this file.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this file is associated with a CRM contextual folder; false for standard workspace files.
Changed property iconUrl (string)
URL to the icon image representing this file's format type in the Seismic UI.
Changed property format (string)
The file format extension (e.g., pptx, pdf, docx) indicating the file type.
Changed property name (string)
The display name of the file as it appears in the workspace.
Changed property parentFolderId (string)
The unique identifier of the parent folder containing this file; "root" indicates the user's root folder.
Changed property deliveryOptions (array)
List of delivery option identifiers available for delivery this file.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace file to delete.
Return Type:
New 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.
New 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.
New 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 response : 200 OK
OK - the workspace file was successfully soft-deleted. The response body is empty.
Changed header : Date
GET /integration/v2/workspace/files/{workspaceContentId}
Parameters:
Changed: workspaceContentId in path
The unique identifier of the workspace file to retrieve information for.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property id (string)
Unique identifier of the workspace file, in UUID format.
Changed property type (string)
Item type discriminator; "file" for file items.
Changed property repository (string)
Repository where the file resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this file resource directly.
Changed property size (number)
Size of the file in bytes.
Changed property versionId (string)
Unique identifier of the current version of the file, in UUID format. Changes whenever a new version is uploaded.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this file was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this file.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this file was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this file.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this file is associated with a CRM contextual folder; false for standard workspace files.
Changed property iconUrl (string)
URL to the icon image representing this file's format type in the Seismic UI.
Changed property format (string)
The file format extension (e.g., "pptx", "pdf", "docx") indicating the file type.
Changed property name (string)
Display name of the file as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this file; "root" indicates the user's root folder.
Changed property deliveryOptions (array)
Array of delivery option references available for delivery this file.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace file to update.
Request:
Changed content type : application/json
Changed property name (string)
New display name for the file. Must be unique within the parent folder.
Changed property parentFolderId (string)
UUID of the destination folder to move the file to. Use "root" for the user's root folder.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the updated workspace file, in UUID format.
Changed property type (string)
Item type discriminator; "file" for file items.
Changed property repository (string)
Repository where the file resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this file resource directly.
Changed property size (number)
Size of the file in bytes (unchanged by metadata updates).
Changed property versionId (string)
Unique identifier of the current version of the file, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this file was originally created, in UTC.
Changed property createdBy (object)
Information about the user who originally created this file.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this file was last modified by this update, in UTC.
Changed property modifiedBy (object)
Information about the user who performed this update.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this file is associated with a CRM contextual folder; false for standard workspace files.
Changed property iconUrl (string)
URL to the icon image representing this file's format type in the Seismic UI.
Changed property format (string)
The file format extension (e.g., "pptx", "pdf", "docx") indicating the file type.
Changed property name (string)
Display name of the file after the update.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this file after the update; "root" indicates the user's root folder.
Changed property deliveryOptions (array)
Array of delivery option references available for delivery this file.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
Repository where the copy resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the newly created file copy, in UUID format. Different from the source file ID.
Changed property versionId (string)
Unique identifier of the initial version of the copy, in UUID format.
Changed property name (string)
Display name of the copy in the destination folder.
Changed property type (string)
Item type discriminator; "file" for file items.
Changed property size (number)
Size of the copied file in bytes (matches the source file size).
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was created, in UTC.
Changed property createdBy (object)
Information about the user who performed the copy operation.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was last modified, in UTC. Equal to createdAt on creation.
Changed property modifiedBy (object)
Information about the user who last modified the copy.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property parentFolderId (string)
Unique identifier of the destination parent folder where the copy was placed; "root" indicates the user's root folder.
Changed property format (string)
The file format extension (e.g., "pptx", "pdf", "docx") of the copy.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access the copy directly.
Changed property isContextualContent (boolean)
Indicates whether the copy is contextual content linked to a CRM entity; inherited from the destination folder context.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
Changed property deliveryOptions (array)
Array of delivery option references applicable to the copy.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace 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.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
Success
Changed content type : application/json
Changed property downloadUrl (string)
Pre-signed HTTPS URL to download the file content directly. Valid for a limited time; re-request if expired.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property id (string)
Unique identifier of the workspace file (unchanged across versions), in UUID format.
Changed property type (string)
Item type discriminator; "file" for file items.
Changed property repository (string)
Repository where the file resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this file resource directly.
Changed property size (number)
Size of the newly uploaded version in bytes.
Changed property versionId (string)
Unique identifier of the newly created version, in UUID format. Previous versions remain accessible under their own versionIds.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the file was originally created, in UTC.
Changed property createdBy (object)
Information about the user who originally created the file.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the new version was uploaded, in UTC.
Changed property modifiedBy (object)
Information about the user who uploaded this version.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this file is associated with a CRM contextual folder; false for standard workspace files.
Changed property iconUrl (string)
URL to the icon image representing this file's format type in the Seismic UI.
Changed property format (string)
The file format extension (e.g., "pptx", "pdf", "docx", "txt") of the new version.
Changed property name (string)
Display name of the file as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this file; "root" indicates the user's root folder.
Changed property deliveryOptions (array)
Array of delivery option references available for delivery this file.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace URL item to delete.
Return Type:
New 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.
New 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.
New 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 response : 200 OK
OK - the workspace URL item was successfully soft-deleted. The response body is empty.
Changed header : Date
GET /integration/v2/workspace/urls/{workspaceContentId}
Parameters:
Changed: workspaceContentId in path
The unique identifier of the workspace URL item to retrieve.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property url (object)
Object wrapping the actual web address the URL item points to.
Changed property id (string)
Unique identifier of the URL item, in UUID format.
Changed property type (string)
Item type discriminator; "url" for URL items.
Changed property repository (string)
Repository where the URL item resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this URL item resource directly.
Changed property versionId (string)
Unique identifier of the current version of the URL item, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this URL item is contextual content linked to a CRM entity.
Changed property iconUrl (string)
URL to the icon image representing this URL item in the Seismic UI.
Changed property format (string)
Format identifier; typically "url" for URL items.
Changed property name (string)
Display name of the URL item as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this URL item; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to this URL item.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace URL item to update.
Request:
Changed content type : application/json
Changed property name (string)
New display name for the URL item. Must be unique within the parent folder.
Changed property parentFolderId (string)
UUID of the destination folder to move the URL item to. Use "root" for the user's root folder.
Changed property url (object)
Object wrapping the updated web address the URL item should point to.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property url (object)
Object wrapping the updated web address the URL item points to.
Changed property id (string)
Unique identifier of the URL item, in UUID format.
Changed property type (string)
Item type discriminator; "url" for URL items.
Changed property repository (string)
Repository where the URL item resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this URL item resource directly.
Changed property versionId (string)
Unique identifier of the current version of the URL item, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was last modified by this update, in UTC.
Changed property modifiedBy (object)
Information about the user who performed this update.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this URL item is contextual content linked to a CRM entity.
Changed property iconUrl (string)
URL to the icon image representing this URL item in the Seismic UI.
Changed property format (string)
Format identifier; typically "url" for URL items.
Changed property name (string)
Display name of the URL item after the update.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this URL item after the update; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to this URL item.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property url (object)
Object wrapping the web address the copied URL item points to. Mirrors the source URL item.
Changed property id (string)
Unique identifier of the newly created URL item copy, in UUID format. Different from the source URL item ID.
Changed property type (string)
Item type discriminator; "url" for URL items.
Changed property repository (string)
Repository where the copy resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access the copied URL item directly.
Changed property versionId (string)
Unique identifier of the initial version of the copy, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was created, in UTC.
Changed property createdBy (object)
Information about the user who performed the copy operation.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was last modified, in UTC. Equal to createdAt on creation.
Changed property modifiedBy (object)
Information about the user who last modified the copy.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether the copy is contextual content linked to a CRM entity.
Changed property iconUrl (string)
URL to the icon image representing the copy in the Seismic UI.
Changed property format (string)
Format identifier; typically "url" for URL items.
Changed property name (string)
Display name of the copy in the destination folder.
Changed property parentFolderId (string)
Unique identifier of the destination parent folder where the copy was placed; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to the copy.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace item (file, folder, or URL) to delete.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
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:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the workspace item, in UUID format.
Changed property type (string)
Item type discriminator; one of "file", "folder", or "url".
Changed property repository (string)
Repository where the item resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this resource directly.
Changed property size (number)
Size of the underlying content in bytes; 0 for folders and URLs that have no binary payload.
Changed property versionId (string)
Unique identifier of the current version of the item, in UUID format. Changes whenever a new version is uploaded.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this item is contextual content linked to a CRM entity; true for CRM-linked items, false otherwise.
Changed property iconUrl (string)
URL to the icon image representing this item's visual type in the Seismic UI.
Changed property format (string)
File format identifier such as "pptx", "pdf", "url", or "folder". Used by clients to decide rendering or download behavior.
Changed property name (string)
Display name of the item as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this item; "root" indicates a top-level item in the user's root.
Changed property deliveryOptions (array)
Array of delivery option references applicable to this item, used to determine how the content can be shared or delivered.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace item (file, folder, or URL) to update.
Request:
Changed content type : application/json
Changed property name (string)
New display name for the workspace item.
Changed property parentFolderId (string)
UUID of the destination folder to move the item to. Use "root" for the user's root folder.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the updated workspace item, in UUID format.
Changed property type (string)
Item type discriminator; one of "file", "folder", or "url".
Changed property repository (string)
Repository where the item resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this resource directly.
Changed property size (number)
Size of the underlying content in bytes; 0 for folders and URLs that have no binary payload.
Changed property versionId (string)
Unique identifier of the current version of the item, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was last modified by this update, in UTC.
Changed property modifiedBy (object)
Information about the user who performed this update.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this item is contextual content linked to a CRM entity; true for CRM-linked items, false otherwise.
Changed property iconUrl (string)
URL to the icon image representing this item's visual type in the Seismic UI.
Changed property format (string)
File format identifier such as "pptx", "pdf", "url", or "folder".
Changed property name (string)
Display name of the item after the update.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this item after the update; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to this item.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json; charset=utf-8
Changed property id (string)
Unique identifier of the newly created copy of the workspace item, in UUID format. Different from the source item ID.
Changed property type (string)
Item type discriminator of the copy; one of "file", "folder", or "url". Matches the source item type.
Changed property repository (string)
Repository where the copy resides; always "workspace" for Workspace API responses.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access the newly created copy directly.
Changed property size (number)
Size of the underlying content in bytes; 0 for folders and URLs that have no binary payload.
Changed property versionId (string)
Unique identifier of the initial version of the copy, in UUID format.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was created, in UTC.
Changed property createdBy (object)
Information about the user who performed the copy operation.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the copy was last modified, in UTC. Equal to createdAt on creation.
Changed property modifiedBy (object)
Information about the user who last modified the copy.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether the copy is contextual content linked to a CRM entity; inherited from the destination folder context.
Changed property iconUrl (string)
URL to the icon image representing the copy's visual type in the Seismic UI.
Changed property format (string)
File format identifier of the copy such as "pptx", "pdf", "url", or "folder".
Changed property name (string)
Display name of the copy in the destination folder.
Changed property parentFolderId (string)
Unique identifier of the destination parent folder where the copy was placed; "root" indicates a top-level item.
Changed property deliveryOptions (array)
Array of delivery option references applicable to the copy.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
The unique identifier of the workspace folder to delete.
Return Type:
New 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.
New response : 403 Forbidden
Forbidden - the authenticated user lacks permission to delete this folder. Verify the seismic.workspace.manage scope is granted and that the user has manage permission on the folder before retrying.
New response : 404 Not Found
Not Found - the requested folder does not exist or the authenticated user cannot see it. Verify the workspaceFolderId is correct and that the folder has not been deleted before retrying.
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.
Deleted header : Cache-Control
Deleted header : Pragma
Deleted header : Transfer-Encoding
Deleted header : X-Content-Type-Options
Deleted header : Strict-Transport-Security
Deleted header : api-supported-versions
Deleted header : Date
Changed content type : application/json
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:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
Repository where the folder resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the workspace folder, in UUID format.
Changed property type (string)
Item type discriminator; "folder" for standard folders for the user's root folder.
Changed property name (string)
Display name of the folder as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this folder; "root" indicates a top-level folder in the user's root.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this folder resource directly.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this folder was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this folder was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this folder is a contextual folder linked to a CRM entity; true for CRM-linked folders, false for standard folders.
Changed property iconUrl (string)
URL to the icon image representing this folder's visual type in the Seismic UI.
Changed property applicationUrls (array)
List of application-specific URLs for opening this folder in Seismic.
The unique identifier of the workspace folder to rename or move.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
Changed property name (string)
New display name for the folder. Must be unique within the parent folder.
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:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
Repository where the folder resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the updated workspace folder, in UUID format.
Changed property type (string)
Item type discriminator; always "folder" for this response.
Changed property name (string)
Display name of the folder after the update.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this folder after the update; "root" indicates a top-level folder.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this folder resource directly.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this folder was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this folder.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this folder was last modified by this update, in UTC.
Changed property modifiedBy (object)
Information about the user who performed this update.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this folder is a contextual folder linked to a CRM entity; true for CRM-linked folders, false otherwise.
Changed property iconUrl (string)
URL to the icon image representing this folder's visual type in the Seismic UI.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
GET /integration/v2/workspace/{workspaceContentId}/members
Parameters:
Changed: workspaceContentId in path
The unique identifier of the workspace item whose member list to retrieve.
Return Type:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed items (object):
Changed property id (string)
Unique identifier of the member user, in UUID format.
Changed property name (string)
The full display name of the collaborator as it appears in Seismic.
Changed property email (string)
The email address of the collaborator used for login and notifications.
Changed property role (string)
The permission role of this member on the item, such as viewer or editor.
Changed property createdAt (string -> string)
ISO 8601 timestamp indicating when this member was added to the item.
GET /integration/v2/users/recents
Return Type:
Changed response : 200 OK
OK
Changed content type : application/json
Changed items (object):
Changed property modifiedAt (string -> string)
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.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Return Type:
New 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.
New 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.
New 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.
New 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 response : 200 OK
OK
Changed content type : application/json
Changed property createdAt (string -> string)
POST /integration/v2/workspace/urls
Parameters:
Changed: openInNewWindow in query
When true, the URL opens in a new browser window; when false it opens in the current window.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
Changed property name (string)
Display name for the new URL item as it will appear in the workspace.
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)
The fully-qualified HTTP or HTTPS web address that the URL item points to.
Changed property description (string)
Optional human-readable description shown alongside the URL item in the workspace UI.
Changed property thumbnail (string)
Optional base64 data URI for a custom thumbnail image; if omitted, a default icon is used.
Changed property mode (string)
Controls how the URL item is rendered when opened in a Seismic application.
Return Type:
New response : 400 Bad Request
Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.
New 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.
New 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 response : 200 OK
OK
Changed content type : application/json
Changed property repository (string)
Repository where the URL item resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the newly created URL item, in UUID format.
Changed property versionId (string)
Unique identifier of the initial version of the URL item, in UUID format.
Changed property name (string)
Display name of the URL item as it appears in the workspace.
Changed property type (string)
Item type discriminator; always "file" for URL items in workspace.
Changed property size (number)
Size of the underlying content in bytes; typically 0 or small for URL items.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was created, in UTC.
Changed property createdBy (object)
Information about the user who created the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when the URL item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified the URL item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing the URL item; "root" indicates a top-level item.
Changed property format (string)
Format identifier of the item; typically "url" for URL items.
Changed property resourceUrl (string)
Fully-qualified REST API URL to access the URL item resource directly.
Changed property isContextualContent (boolean)
Indicates whether this URL item is contextual content linked to a CRM entity.
Changed property iconUrl (string)
URL to the icon image representing the URL item in the Seismic UI.
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.
Changed property url (string)
Fully-qualified HTTPS URL for opening this workspace item in the Seismic web application.
Changed property deliveryOptions (array)
Array of delivery option references applicable to the URL item.
Changed items (object):
Changed property id (string)
Delivery option UUID identifying the sharing/delivery configuration available for this workspace item.
Changed property content (array)
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:
New 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.
New 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.
New response : 404 Not Found
Not Found - the requested resource does not exist or the authenticated user cannot see it. Verify the identifier is correct and that the resource has not been deleted before retrying.
Changed response : 200 OK
OK
Changed content type : application/json
Changed property itemCount (number -> integer)
Total number of items returned in the items array. When recursive=true this counts all nested items, not just direct children.
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 repository (string)
Repository where the item resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the workspace item, in UUID format.
Changed property type (string)
Item type discriminator; one of "file", "folder", or "url".
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this item directly.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this item is contextual content linked to a CRM entity.
Changed property name (string)
Display name of the item as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this item; matches the workspaceContentId of the folder being listed.
Changed property applicationUrls (array)
List of application-specific URLs for opening this item in Seismic.
Changed content type : text/plain
Changed property itemCount (number -> integer)
Total number of items returned in the items array. When recursive=true this counts all nested items, not just direct children.
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 repository (string)
Repository where the item resides; always "workspace" for Workspace API responses.
Changed property id (string)
Unique identifier of the workspace item, in UUID format.
Changed property type (string)
Item type discriminator; one of "file", "folder", or "url".
Changed property resourceUrl (string)
Fully-qualified REST API URL to access this item directly.
Changed property createdAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was originally created, in UTC.
Changed property createdBy (object)
Information about the user who created this item.
Changed property id (string)
User ID (UUID) of the Seismic user who created this item; use to look up user details via the Users API.
Changed property modifiedAt (string -> string)
RFC 3339 / ISO 8601 timestamp indicating when this item was last modified, in UTC.
Changed property modifiedBy (object)
Information about the user who last modified this item.
Changed property id (string)
User ID (UUID) of the Seismic user who last modified this item; use to look up user details via the Users API.
Changed property isContextualContent (boolean)
Indicates whether this item is contextual content linked to a CRM entity.
Changed property name (string)
Display name of the item as it appears in the workspace.
Changed property parentFolderId (string)
Unique identifier of the parent folder containing this item; matches the workspaceContentId of the folder being listed.
Changed property applicationUrls (array)
List of application-specific URLs for opening this item in Seismic.
GET /integration/v2/users/{userId}
Return Type:
Changed response : 200 OK
OK
Changed content type : application/json
Changed property createdAt (string -> string)
GET /integration/v2/users/profiles
Return Type:
Changed response : 200 OK
OK
Changed content type : application/json
Changed items (object):
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.
Changed: Content-Type in header
MIME type of the request body; must be 'application/json' for this endpoint.
Request:
Changed content type : application/json
Return Type:
New 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.
New 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.
New 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.
New 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 response : 200 OK
OK
Changed content type : application/json
Changed property createdAt (string -> string)
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:
New 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.
New 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.
New 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 response : 200 OK
OK
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
Changed property id (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.
Return Type:
New response : 400 Bad Request
Bad Request
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 404 Not Found
Not Found
New response : 409 Conflict
Conflict
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
Changed content type : application/json
Changed property id (string -> string)
User ID of the member who was added as a collaborator; equivalent to the id field supplied in the request body.
Changed property name (string)
Display name of the user who was added as a collaborator on this workspace item.
Changed property email (string)
Email address of the user who was added as a collaborator on this workspace item.
Changed property role (string)
Permission role granted to the member: Manager allows edit and view access; Viewer allows view-only access.
Added enum values:
Manager
Viewer
Changed property createdAt (string -> string)
RFC 3339 UTC timestamp indicating when the member was added to this workspace content (e.g., 2025-07-16T00:00:00Z).
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:
New response : 400 Bad Request
Bad Request
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 404 Not Found
Not Found
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
New content type : application/json
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
Changed property ownerId (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:
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 500 Internal Server Error
Internal Server Error
Changed response : 400 Bad Request
Bad Request
Changed content type : text/plain
Changed response : 404 Not Found
Not Found
Changed content type : text/plain
GET /workspace/v1/files/{workspaceContentId}/customProperties
Parameters:
Changed: includeInvisibledInDC in query
Controls property visibility filter: true returns all properties including those hidden in DocCenter (Seismic's content library portal); false (default) returns only visible properties. Use true when auditing all configured properties on a file.
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.
Return Type:
New response : 400 Bad Request
Bad Request
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 404 Not Found
Not Found
New response : 500 Internal Server Error
Internal Server Error
Changed response : 200 OK
OK
Changed content type : application/json
Changed property properties (array)
List of custom properties associated with the workspace file, sourced from DocCenter configuration.
Changed items (object):
Changed property id (string -> string)
Unique identifier of the custom property definition configured in DocCenter (Seismic's content library portal); use this as the property reference key for update operations.
Changed property name (string)
Display name of the custom property as it appears in DocCenter content views.
Changed property values (array)
List of string values currently assigned to this custom property for the workspace file.
Changed property isVisibleInDocCenter (boolean)
Indicates whether this custom property is visible to users browsing content in DocCenter (Seismic's content library portal).
Indicates whether this property appears as a filter option when browsing or searching in DocCenter (Seismic's content library portal).
Changed property orderIndex (number)
Numeric index controlling the display order of this property relative to others in DocCenter views; lower values appear first.
GET /workspace/v1/files/{workspaceContentId}/versions
Parameters:
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:
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
New response : 500 Internal Server Error
Internal Server Error
Changed response : 404 Not Found
Not Found
New content type : application/problem+json
Deleted content type : application/json
Changed response : 200 OK
OK
Changed content type : application/json
Changed property id (string -> string)
Unique identifier of the workspace content file, equivalent to the workspaceContentId path parameter. Use this value as workspaceContentId in subsequent API calls.
Changed property name (string)
Display name of the workspace content file as shown in the workspace.
Changed property versions (array)
Ordered list of all version records returned for this page of the workspace content file's version history.
Changed items (object):
Changed property id (string -> string)
Unique identifier of this specific file version record, equivalent to versionId. Use this value when referencing a specific version in version-related operations.
Changed property version (integer)
Sequential version number starting from 1, Incremental after each new version.
Changed property createdBy (string -> string)
User ID of the person who created or uploaded this file version.
Changed property createdAt (string -> string)
RFC 3339 UTC timestamp indicating when this version was created or uploaded; all timestamps are in UTC (e.g., 2025-07-16T00:00:00Z).
Changed property versionCreationMethod (string)
Indicates how this file version was created; for example Upload means a direct file upload, Copy means duplicated from another file, OneDrive Sync or Google Sync means synced from cloud storage.
Added enum values:
UNKNOWN
LiveSend
Add to Cart
Add to MeetingSpace
Copy
Save to Workspace
Record
Freestyle
Guided Assembly
LiveDoc Generated
LiveDoc Iteration
Automatic Update
Upload
Revert to PPT
Convert to PDF
Restore
Edit With Office Online
OneDrive Sync
Google Sync
Meeting Recording
Changed property sourceContent (object)
Reference to the original source content when this version was created by copying another file; only present when versionCreationMethod is Copy.
Changed property contentId (string -> string)
Workspace content ID of the source file from which this version was copied.
Changed property versionId (string -> string)
Version ID of the specific source file version that was copied to create this version.
