Jump to Content
Seismic Developer PortalGuidesAPI DocsChangelogMy AppsSeismic Exchange
HomeGuidesAPI DocsChangelog
GuidesAPI DocsChangelogMy AppsSeismic ExchangeSeismic Developer Portal
API Docs
HomeGuidesAPI DocsChangelog

Introduction

  • Overview
  • Conventions and Formats
    • Date Formats
    • PATCH Conventions
    • Pagination
    • Content Classes
    • Rate Limiting
    • Errors
  • Versioning & Testing

Authentication

  • Authentication Overviewget
  • Permissions
  • Login with implicit flow
    • Overview
    • 1. Create your client page
    • 2. Create your redirect page
    • Example
  • Login with authorization_code flow
    • 1. Get the user's authorization
    • 2. Exchange the Authorization Code for an Access Tokenpost
    • 3. Exchange the Refresh Token for an Access & Refresh Tokenpost
  • Login with authorization_code + PKCE flow
    • 1. Authorization Code + PKCE — Get Authorization Code
    • 2. Exchange the Authorization Code for an Access Token (PKCE flow)post
    • 3. Exchange the Refresh Token for an Access & Refresh Token (PKCE flow)post
  • Login with client credentials flow
    • 1. Get a token using client credentialspost
  • Login with password flow
    • 1. Get a token using username and passwordpost
  • Get a token using OAuth2 flow in postman
  • Additional Information
    • Get Open ID configurationget

Reporting (v2)

  • Reporting Overview
  • *Data Dictionary
    • Fieldsget
    • Tablesget
  • Activity History
    • Admin Impersonation Sessionsget
    • Content Usage Historyget
    • Content View Historyget
    • Daily Active Usersget
    • Distribution Approval Workflowsget
    • Distribution Approval Workflow Steps Historyget
    • Interaction Contextsget
    • Interaction Recipientsget
    • Notification Frequency Settingsget
    • Notification Statusget
    • User Activityget
    • Virus Scan Audit Logget
  • AI
    • Ai Activityget
    • Ai Generated Textget
    • Ai Aura Activityget
    • Ai Generated Text User Feedbackget
    • Ai Aura Activity Content Detailsget
    • Ai Suggested Content Propertiesget
    • Copilot For Sales Recommendationsget
  • Analytics Apps
    • Self Service Reportsget
    • Self Service Reports Activityget
  • Channels
    • Announcementsget
    • Channelsget
    • Postsget
    • Post Contentsget
  • Content Interaction
  • Content Manager
  • Contents
    • Contentsget
    • Content Activitiesget
    • Content Ask Expertsget
    • Content Insert Instancesget
    • Content Pagesget
    • Content Reviewsget
    • Content Slide Insert Instancesget
    • Content Versionsget
    • Meeting Topicsget
    • Custom Propertiesget
    • Custom Property Assignmentsget
    • Meetingsget
    • Meeting Agenda Updatesget
    • Meeting Content Page Presentationsget
    • Meeting Content Presentationsget
    • Meeting General Notes Updatesget
    • Meeting Keywordsget
    • Meeting Participantsget
    • Meeting Questionsget
    • Meeting Trackersget
    • Page Clicksget
    • Page Content Historyget
    • Watermarksget
  • DSRs
    • Digital Sales Roomsget
    • Digital Sales Room Viewing Sessionsget
  • Emails
    • Emailsget
    • Email Template Instancesget
    • Email Template Section Selectionsget
    • Email Template Static Imagesget
    • Email Template Variable Valuesget
  • Interactions
  • Journeys
  • Learning
    • Answersget
    • Assignmentsget
    • Custom User Fieldsget
    • Custom User Field Valuesget
    • Group Managersget
    • Elearning Filesget
    • Feedback Criteriaget
    • Elearning Interactionsget
    • Instructor Led Training Eventsget
    • Elearning Resultsget
    • Instructor Led Training Event Attendanceget
    • Instructor Led Training Event Content Assignmentsget
    • Training Group Managersget
    • Instructor Led Training Event Sessionsget
    • Learning Journeysget
    • Learning Journey Stepsget
    • Learning Journey Tasksget
    • Learning Progressget
    • Learning Statusesget
    • Lessonsget
    • Lesson Tagsget
    • Lesson Versionsget
    • Pathsget
    • Path Contentsget
    • Path Tagsget
    • Proficiency Levelsget
    • Questionsget
    • Skillsget
    • Skill Assessmentsget
    • Skill Profilesget
    • Skill Profile Detailsget
    • Skill Coaching Roomsget
    • Skill Ratingsget
    • Skill Coaching Room Sessionsget
    • Skill Requestsget
    • Skill Coaching Room Skillsget
    • Skill Reviewsget
    • Skill Coaching Room Tasksget
    • Skill Tagsget
    • Skill User Profilesget
    • Training Groupsget
    • Training Group Membersget
  • Lessons
  • Library Contents
    • Content Profilesget
    • Content Profile Assignmentsget
    • Content Profile Assignments Historyget
    • Content Propertiesget
    • Content Property Assignmentsget
    • Custom Contentsget
    • Custom Content Typesget
    • Custom Content Type Fieldsget
    • Digital Sales Room Templatesget
    • Digital Sales Room Template Versionsget
    • External Content Detailsget
    • Favorite Statusget
    • Follow Statusget
    • Library Contentsget
    • Library Content Expert Associationsget
    • Library Content Versionsget
    • Programsget
    • Program Associationsget
    • Program Datesget
    • Program Itemsget
    • Program Requestsget
    • Program Request Datesget
    • Program Tasksget
    • Program Task Datesget
    • Publishing Approval Workflowsget
    • Publishing Approval Workflow Acknowledgementsget
    • Publishing Approval Workflow Steps Historyget
    • Teamsitesget
    • Roleplay Sessionsget
  • LiveDocs
    • Generated Livedocsget
    • Generated Livedoc Componentsget
    • Generated Livedoc Fieldsget
    • Generated Livedoc Output Formatsget
    • Generated Livedoc Slidesget
    • Livedoc Custom Content Data Source Retrieve Data Requestsget
    • Livedoc Data Source Infoget
    • Livedoc Data Source Retrieve Data Requestsget
    • Livedoc Global Variable Requestsget
  • LiveSend
    • Livesend Commentsget
    • Livesend Comment Mentionsget
    • Livesend Comment Reactionsget
    • Livesend Content Viewing Sessionsget
    • Livesend Linksget
    • Livesend Link Contentsget
    • Livesend Link Meeting Contentsget
    • Livesend Link Content Version Historyget
    • Livesend Link Membersget
    • Livesend Page Viewsget
    • Livesend Viewing Sessionsget
    • Microapp Screensget
    • Microapp Screen Viewsget
  • Meetings
    • Meeting Templatesget
  • Pages
  • Programs
    • Program Success Metricsget
  • Search
    • Search Clicksget
    • Search Click Match Detailsget
    • Search Facetsget
    • Search Historyget
    • Search Wordsget
  • Skills
    • Skill Scorecard Questionsget
    • Skill Scorecard Question Skillsget
    • Skill Scorecard Templatesget
  • Training Events
  • Users & Groups
    • Connected Accountsget
    • External Usersget
    • Groupsget
    • Group Membersget
    • Indirect Group Managersget
    • Indirect Group Membersget
    • Usersget
    • Organizational Structuresget
    • User Groups Listget
    • User Propertiesget
    • User Property Assignmentsget
    • Rolesget
    • User Permissionsget
    • User Role Assignmentsget
  • Workflows
  • Workspace
    • Workspace Contentsget
    • Workspace Content Versionsget

Approval Workflow

  • Approval Workflow
    • Get list of workflowspost
    • Operate workflowput
    • Get workflow detailsget
    • Operate workflow stepput

Channel

  • Channel
    • Get the list of channelsget
    • Create a new channelpost
    • Get the channel detailsget
    • Update the channel detailsput
    • Delete the channeldel
  • Post
    • Get the list of posts in the channelget
    • Get the list of postsget
    • Create a new postpost
    • Get the post detailsget
    • Update the post detailsput
    • Delete the postdel

Configuration

  • Content Properties
    • Get content property valuesget
    • Add one or more content property valuespost
    • Get content propertiesget
    • Add a content propertypost
  • Custom Properties
    • Create a custom propertypost
    • Find custom properties by filterget
    • Get a custom propertyget
    • Update a custom propertyput
    • Delete a custom propertydel

Content

  • Content Augmentation
    • Download the watermarked content.post
  • Content Access
    • Bulk get content access datapost
    • Remove content access for membersdel
    • Update content access for memberspost
  • Content Profile Reference
    • Add contents to profilespost
    • Remove contents from profilesdel
  • External Content Management
    • Add external file to Librarypost
    • Get content sync statusget

Crm

  • Activity Logging
    • Get list of activitiesget
    • Get activity detailsget

Custom Content

  • Custom Content
    • Get custom contentget
    • Add custom contentpost
    • Add custom content versionpost

Custom Schema

  • Custom Schema Service
    • Retrieve the latest schemas by status, name, and spaceIdsget
    • Create a schema with a name, description and fields details.post
    • Retrieve the latest version of schema by `schema_Id`.get
    • Update a schema and returns the updated schema.put
    • Delete a schema by the given id.del
    • Retrieve a schema at the given versionget

Digital Sales Room

  • DSR
    • Create a new DSRpost
    • Get a list of DSRget
    • Get details for a specific DSRget
    • Create a new DSR from templatepost
    • Get comments from DSRget
    • Add viewer ACL for DSR or LiveSendput
    • Bulk add or remove viewer ACL for DSR or LiveSendpatch
    • Get DSR V2get

Document Generator Express

  • Document Generator Express Batch
    • Create a new processpost
    • Get processesget
    • Generate documents from processpost
    • Schedule execution of processpost
    • Get scheduled processesget
    • Configure dynamic variant filterpost
    • Get process execution historyget
    • Get process variantsget
    • Update processput
    • Delete processdel
    • Define the set of process Document Generatorsput
    • Update job history detailspatch
    • Cancel scheduled processdel
    • Get variants from jobget
    • Get download URLs from jobget
    • Get job Document Generatorsget
    • Get job statusget
    • Get process variant countget
    • Cancel jobpatch
    • Run Document Generator jobpost
    • Import variants from CSVpost
    • Upload variant CSVpost
    • Create variantspost
    • Get Document Generator variantsget
    • Delete Document Generator version variantsdel
    • Bulk delete variantspatch
    • Copy variantspost
    • Get Document Generator execution historyget
    • Export variants as CSVget
    • Download CSV variant templateget
    • Get Document Generator job historyget
    • Get variant job historyget
    • Update variantput
    • Delete variantdel
    • Bulk variant updateput

Document Generator Process

  • Data Source
    • Get Data Source Inputsget
    • Retrieve Datapost
    • Get Data Source Version Infoget
  • Document Generator
    • Get the tracked fieldsget
    • Get the list of inputs for a Document Generatorget
    • Run a Document Generatorpost
    • Get status of Document Generator processget
    • Download a Document Generator outputget
  • Form
    • Get Form Seller Templatesget

Document Generator

  • Document Generator (Advanced)
    • Get Document Generator inputsget
    • Create Document Generator outputpost
    • Get Document Generator output statusget
    • Download Document Generator outputget
    • Search contentpost
    • Get slide thumbnailspost
    • Upload imagepost
    • Download imageget

Engagement

  • Delivery
    • Get the list of delivery optionsget
    • Get list of inputs for a custom delivery formget
    • Deliver content via custom deliverypost
    • Save a file to Workspacepost
  • Email
    • Create Email Templatepost
  • Distribution Lists
    • List all distribution lists for the authenticated userget
    • Create a new distribution listpost
    • Get a distribution list by ID, including all contact entriesget
    • Update a distribution listput
    • Delete a distribution listdel
  • Engagement Permission
    • Get collaboratorsget
    • Delete collaboratorsdel
    • Add collaboratorspost
    • Update collaboratorsput
  • Engagement
    • Get the engagement listget
    • Get the engagement list V2get
    • Get the engagement list for AI agentget
    • Get the crm context listget
  • Link Delivery
    • Create Link Deliverypost
  • LiveSend (Legacy)
    • Create a new livesend linkpost
    • Get livesend settingsget
  • LiveSend
    • Generate LiveSend linkpost
    • Get LiveSend versionget

Intelligence Services

  • Intelligence Services
    • Intelligence recommendersget
    • Intelligence content recommendationspost

Learning

  • Lessons
    • Force completion of a progress for a userpost

Library

  • Library Content Management
    • Add a filepost
    • Change file information/propertiespatch
    • Get file information/propertiesget
    • Add a new file versionput
    • Download a fileget
    • Download a file versionget
    • Copy a filepost
    • Add a folderpost
    • Get folder informationget
    • Change folder informationpatch
    • Copy a folderpost
    • Get list of items in a folderget
    • Delete an itemdel
    • Get item information/propertiesget
    • Copy an itempost
    • Get all versions for an itemget
    • Get items via queryget
    • Replace thumbnail on an itemput
    • Add a URLpost
    • Change url information/propertiespatch
    • Get url information/propertiesget
    • Copy a URLpost
    • Get/create folder by pathput
  • Library Instructions
    • Add an instruction on an itempost
    • Get instructions on an itemget
    • Delete an instruction on an itemdel
  • Library Workflow
    • Submit a document into workflowput
    • Recall a document from workflowput
    • Approve or reject workflow stepput
    • Get information for a particular workflowget
    • Get list of approval workflowsget
  • Library Publishing
    • Publish one or more documentspost
    • Unpublish a documentput

Meeting

  • Meetings
    • Get the meeting details by idget
    • Get the meeting listget
    • Get the meeting sessions by idget
    • Get the meeting recording files by meeting idget
    • Get the meeting recording files by recording idget
    • Get the transcript analysis of meeting by meeting idget
    • Get the overview of a post meeting by meeting idget
    • Get the overview of a meeting by meeting idget
    • Get all meeting data for a specific meeting versionget
    • Get list of meeting contents by meeting id which can be shared with other usersget
    • Manually ingest a meetingpost
    • Add or update the agenda for a draft meetingpost
    • Add or update the notes for a meetingpost
    • Add contents to a meetingpost

Platform Audit

  • Public Audit Data Query
    • Query audit recordspost
    • Create audit data export taskpost
    • Get audit export task statusget
    • Download audit export task resultget

Presentation Builder

  • Presentation Builder
    • Query the list of inputs for a Presentation templatepost
    • Generate a Presentation Builder by templatepost
    • Get status of Presentation Builder Generationget
    • Download a particular output from a Presentation Builder generationget
    • Create a presentationpost
    • Get presentationget
    • Get slide metadata for a content versionget
    • Search eligible contentpost

Privacy Management

  • Privacy Management
    • Add or update one or more emails in the optout listput
    • Get email optout listget
    • Delete an email from the optout listdel

Programs

  • Access
    • Get programs accessget
  • Activity
    • Get all activitiesget
    • Get activity for one entityget
  • Async Action
    • Get asynchronous operation statusget
  • Association
    • Get associations for one entityget
    • Add entities to a program, task, or requestpost
    • Remove entities from a program, task, or requestpost
  • Comment
    • Get all comments for one entity (program, task, or request)get
    • Create a new comment on a program, task, or requestpost
    • Get a specific comment on one entity (program, task, or request)get
    • Update the content or metadata of an existing commentput
    • Delete a comment from a program, task, or requestdel
  • Follower
    • Get followers for one entity (program, task, or request)get
    • Add followerspost
    • Remove followersdel
  • Program
    • Get all programsget
    • Create a programpost
    • Delete multiple programs in a single operationdel
    • Get one programget
    • Update an existing programput
    • Delete a programdel
    • Get content within a programget
    • Get programs managed by the authenticated userget
    • Group programs by specified attributesget
    • Create a program template from an existing programpost
    • Query program templatesget
    • Bulk update multiple programs with partial updatespatch
  • Program Template
    • Create a program templatepost
    • Delete program templatesdel
    • Get predefined program templatesget
    • Get one program templateget
    • Update a program templateput
    • Apply a program templatepost
    • Apply a predefined program templatepost
    • Bulk update program templates with partial updatespatch
  • Request Form
    • Get request formsget
    • Create a request formpost
    • Get one request formget
    • Update a request formput
    • Delete a request formdel
    • Update request form permissionspost
    • Activate a request formput
    • Deactivate a request formput
  • Request
    • Get all requestsget
    • Create a new content requestpost
    • Bulk delete multiple requests from the spacedel
    • Get one requestget
    • Update an existing request with complete replacement of editable fieldsput
    • Delete a request from the spacedel
    • Get requests assigned to the authenticated userget
    • Bulk update multiple requests with partial updatespatch
    • Group requests by specified attributesget
  • Rank
    • Update entity rank positionput
  • Saved View
    • Create a saved viewpost
    • Get saved viewsget
    • Get one saved viewget
    • Update a saved viewput
    • Delete saved viewdel
  • Space
    • Get all spacesget
    • Get one spaceget
  • Status Schema
    • Get status schemasget
    • Get one status schemaget
  • Task
    • Get all tasksget
    • Create a new taskpost
    • Get task templatesget
    • Create a task templatepost
    • Get one taskget
    • Update a taskput
    • Delete a taskdel
    • Get one task templateget
    • Update a task templateput
    • Delete a task templatedel
    • Get tasks assigned to the authenticated userget
    • Bulk update tasks with partial updatespatch
    • Group tasks by specified attributesget
    • Delete tasksdel
    • Delete task templatesdel

Search

  • Core Search
    • Content Searchpost
  • Generative Search
    • Generative Search Sourcepost
    • Generative searchpost

Skills

  • ScorecardTemplates
    • Get Scorecard Templatesget

Teamsites

  • Teamsites
    • Get a list of all teamsitesget
    • Get information for a specific teamsiteget

User Management

  • User Roles across Seismic Content and Learning
  • SCIM User and Group Management
    • Retrieve all groups || Retrieve groups matching certain criteriaget
    • Create a new grouppost
    • Delete a group by GUIDdel
    • Retrieve a group by GUIDget
    • Update certain attributes within a grouppatch
    • Update a group with a full payloadput
    • Get a list of members of a specific groupget
    • Get resource typesget
    • Get current tenant schemaget
    • Get service provider configurationget
    • Retrieve all users || Retrieve users matching certain criteriaget
    • Create a new userpost
    • Delete a user by GUIDdel
    • Retrieve a user by GUIDget
    • Update certain attributes within a userpatch
    • Update a user with a full payloadput
    • Get a list of groups a specific user belongs toget
    • Remove a user from a groupdel
    • Add a user to a grouppost
  • Users (Legacy)
    • Get list of users (Legacy)get
    • Get the user details for the specified id (Legacy)get

User Resources

  • User Resources
    • Get my favorite contentsget
    • Get my recent contentsget
    • Get my assigned teamsitesget
    • Get list of my assigned profilesget

Variable

  • Variable
    • Create Variablepost
    • Update Variableput
    • Get Variable Definitionget
    • Get All Variable Definitionsget
    • Get Value Type Formattersget
    • Get Variable Valuepost
    • Get Variable Valuespost

Workspace

  • Workspace Content
    • Get file versions infoget
    • Get file custom propertiesget
  • Workspace Content Management
    • Add a folderpost
    • Copy a folderpost
    • Create/get a contextual workspace folderpost
    • Add a filepost
    • Get file informationget
    • Delete a filedel
    • Update file metadatapatch
    • Copy a filepost
    • Download a fileget
    • Upload a new file versionput
    • Create an urlpost
    • Get a urlget
    • Update url metadatapatch
    • Delete a urldel
    • Copy a urlpost
    • Get an item's metadataget
    • Update an itempatch
    • Delete an itemdel
    • Copy an itempost
    • Get information about a folderget
    • Update a folderpatch
    • Delete a folderdel
    • Get the list of items in a folderget
  • Workspace Permissions
    • Add a member to contentpost
    • Remove a member from contentdel
    • Transfer owner of content to memberput
  • Workspace Permissions/Sharing
    • Get the list of members on an itemget
  • Workspace Comments
    • Get comments on an itemget
    • Add a comment to an itempost
    • Add a reply to a commentpost
    • Delete a commentdel
    • Delete a replydel
    • Resolve a commentput

Lessons

Updated 22 days ago


Training Group Members
Library Contents
Did this page help you?

Updated 22 days ago


Training Group Members
Library Contents
Did this page help you?
About Terms of Use Privacy Policy Seismic Exchange Contact Us