Workspaces
Creates a new workspace
Creates a new workspace › Request Body
nameregionorganization_idcompany_id_numberA valid company ID number
tax_idtax_idsvat_idintegration_idCreates a new workspace › Responses
Get workspace metadata
path Parameters
workspace_idA unique UUID or humanized id identifier
query Parameters
includeComma separated list of additional data which can be returned for each workspace
excludeComma separated list of data to be excluded
Get workspace metadata › Responses
Patch workspace metadata
path Parameters
workspace_idA unique UUID or humanized id identifier
Patch workspace metadata › Request Body
nameA name of the workspace
register_idtax_idtax_idsvat_idicon_color^#?([0-9A-F]{3}|[0-9…Patch workspace metadata › Responses
Patch workspace integration connection status
path Parameters
workspace_idA unique UUID or humanized id identifier
Patch workspace integration connection status › Request Body
integration_connection_statusConnection status of workspace
global_errorGlobal error of workspace eg. connection issues
global_error_descriptionGlobal error description of workspace eg. connection issues
Patch workspace integration connection status › Responses
Get workspace documents
path Parameters
workspace_idA unique UUID or humanized id identifier
query Parameters
excludeComma separated list of additional data which can be excluded for each document.
includeformattingEnum: regular | simplified
searchFilter documents by fields
Get workspace documents › Responses
array of response data
pagination
Post workspace integration log
path Parameters
workspace_idA unique UUID or humanized id identifier
Post workspace integration log › Request Body
typeEvent type
messageHuman-readable message for user
document_idDocument ID reference in case an event is directly associated to the document
detailsAn object used for storing miscellaneous data related to the event and used for debugging
Post workspace integration log › Responses
Get workspace queues user has access to
path Parameters
workspace_idA unique UUID or humanized id identifier
query Parameters
includeComma separated list of additional data which can be returned for each queue
excludeComma separated list of data to be excluded
Get workspace queues user has access to › Responses
A list of queues
Creates a new queue in specified workspace
path Parameters
workspace_idA unique UUID or humanized id identifier
Creates a new queue in specified workspace › Request Body
typenameA name of a queue
localecurrencyCurrency assigned to the queue (ISO code)
approvalWhether to use approval flow
extractionWhether to allow extraction of documents