Jump to Content
Home
Guides
API
Home
Guides
Recipes
API
v10
v10.1
v10.2
v10.3
v11.0
v11.1
v11.2
v12.0
v13
v14
v15
v16
v17
v31
Home
Guides
API
Log In
API
Log In
v13
API
Expire session token
Search
All
Pages
Start typing to search…
These docs are for v13. Click to read the latest docs for v31.
JUMP TO
Overview
Introduction
Sample Code
Exploring as Learning
Additional Information
Error Responses
SmartIQ Administrator API
Authentication
Forms Authentication
post
Windows Authentication
post
SAML Authentication
post
Cookie Authentication
post
Expire session token
post
Projects
Get projects
get
Imports a project
post
Get specific project
get
Renames a project
patch
Deletes a project
delete
Get project version history
get
Export a project
get
Export a project version
get
Exports a sync pack
post
Imports a sync pack
post
Content Folders
Get Content folders
get
Creates a content folder
post
Get content folder details
get
Updates a content folder
patch
Deletes a content folder
delete
Publish Folders
Get folders
get
Creates a publish folder
post
Get publish folder details
get
Updates a folder
patch
Deletes a folder
delete
Publish Projects
Get published projects
get
Publishes a project
post
Get publishing details
get
Updates publish details
patch
Un-publishes a project
delete
Users
Get users
get
Creates a user
post
Get user details
get
Update user details
patch
Delete a user
delete
Get user details by name
get
Update user details by name
patch
Delete a user by name
delete
Get user details (deprecated)
get
Updates user details (deprecated)
patch
Deletes a user (deprecated)
delete
Groups
Get user groups
get
Create a group
post
Get group details
get
Updates group details
patch
Deletes a group
delete
Get group members
get
Roles
Get roles
get
Create a role
post
Get role details
get
Updates role details
patch
Deletes a role
delete
Workflow
Get workflow
get
Get workflow details
get
Aborts a workflow
delete
Reassigns a workflow
post
Returns a workflow to its previous state
post
Project Results
Get project results for reporting
get
Device Log
Get device log
get
Interaction Log
Get interaction log
get
Get interaction drop off log
get
Get interaction page log
get
Get interaction time log
get
Get interaction save log
get
License
Get license details
get
Update license
post
Get Tenancy Key
get
Get transactional license log
get
Data Connections
Get data connections
get
Create a data connection
post
Get data connection details
get
Updates data connection details
patch
Deletes a data connection
delete
Get data objects for a data connection
get
Create a data object
post
Get data object details
get
Updates data object details
patch
Deletes a data object
delete
Content Library
Get content items
get
Create a content item
post
Get content item details
get
Updates content item details
patch
Deletes a content item
delete
Get content item history details
get
Get content item binary
get
Connector Settings
Get Connector Settings
get
Get connector setting element detail
get
Updates a connector Setting Value
patch
Custom Fields
Get Custom Fields
get
Create a custom field
post
Gets a custom field
get
Updates a custom field
patch
Communication Template
Get communication template
get
Create a communication template
post
Get communication template details
get
Updates communication template details
patch
Deletes a communication template
delete
Approvals
Get approvals
get
Create an approval
post
Deletes an approval
delete
Updates approval details
patch
Approval
Get approval details
get
Sequences
Get sequences
get
Create a sequence
post
Get sequence details
get
Updates sequence details
patch
Deletes a sequence
delete
Jobs
Get jobs
get
Get Job
get
Path Scheduled Job
patch
Events
Get Event Log Messages
post
SmartIQ Client API
Authentication
Forms Authentication
post
Windows Authentication
post
SAML Authentication
post
Cookie Authentication
post
Expire session token
post
Generation
Generates a form
post
Operations
Get the last resources state for a runId
get
Get resources state
get
Delete resources
delete
Generate Output
Get generated outputs
get
Get generated output binaries
get
Answerfiles
Get user's available answer files
get
Creates an answer file
post
Get specific answer file
get
Deletes an answer file
delete
Inprogress Answerfiles
Get a user's in-progress answer files
get
Creates an in-progress answer file
post
Get specific in-progress answer file
get
Updates an in-progress answer file
patch
Deletes an in-progress answer file
delete
Forms
Get available forms
get
Workflow
Get available workflow items
get
Get workflow item
get
Unlocks a group workflow task
patch
Cancels a workflow task
delete
Reassigns a workflow task to another user
post
Returns a workflow to its previous state
post
Submits workflow to next state
post
Prepare Form
Prepares a form to be launched by the user with pre-supplied data
post
Inprogress Answerfiles Workflow
Get a user's in-progress tasks (workflow and answer files)
get
Expire session token
post
https://localhost/producev13_Last/api/v1/client/logoff
Expire session token
Language
Shell
Node
Ruby
JavaScript
Python
