Account
getTokenInfo
account.getTokenInfo
Get the user id behind the current API token
Risk: read
listLicenses
account.listLicenses
List the account licenses and subscriptions
Risk: read
object[]
Output full type
Output full type
Audit
list
audit.list
List account audit log entries, newest first
Risk: read
object[]
Output full type
Output full type
Connections
create
connections.create
Create a connection
Risk: write
delete
connections.delete
Delete a connection
Risk: destructive · Irreversible
evaluateVirtualImportMap
connections.evaluateVirtualImportMap
Run only the mapping step of an unsaved import and return the mapped records
Risk: read
any[] \| Record<string, any>
executeVirtualExport
connections.executeVirtualExport
Run an unsaved export definition through a connection
Risk: write
executeVirtualExportPaged
connections.executeVirtualExportPaged
Run an unsaved export one page at a time. Pass back pagedExportState for the next page
Risk: write
executeVirtualImport
connections.executeVirtualImport
Send records through an unsaved import definition
Risk: write
object[]
Output full type
Output full type
get
connections.get
Get a connection by id
Risk: read
getAudit
connections.getAudit
List audit log entries for a connection
Risk: read
object[]
Output full type
Output full type
getDebugLogs
connections.getDebugLogs
Get the debug log text recorded for a connection
Risk: read
getDependencies
connections.getDependencies
List resources that depend on a connection
Risk: read
Record<string, any>
list
connections.list
List connections in the account
Risk: read
object[]
Output full type
Output full type
patch
connections.patch
Apply JSON Patch operations to a connection
Risk: write
operations full type
operations full type
ping
connections.ping
Test that a saved connection can reach its application
Risk: read
object
Output full type
Output full type
testVirtual
connections.testVirtual
Test an unsaved connection document without storing it
Risk: read
object
Output full type
Output full type
update
connections.update
Replace a connection document
Risk: write
Edi Profiles
list
ediProfiles.list
List EDI trading partner profiles
Risk: read
object[]
Output full type
Output full type
Errors
assign
errors.assign
Assign flow step errors to a user by email
Risk: write
deleteResolved
errors.deleteResolved
Purge resolved errors from a flow step
Risk: destructive · Irreversible
list
errors.list
List open errors for one export or import step of a flow
Risk: read
errors full type
errors full type
listResolved
errors.listResolved
List resolved errors for one step of a flow
Risk: read
resolved full type
resolved full type
resolve
errors.resolve
Mark errors on a flow step as resolved
Risk: write
retry
errors.retry
Retry failed records on a flow step
Risk: write
updateTags
errors.updateTags
Set tags on flow step errors
Risk: write
errors full type
errors full type
Exports
clone
exports.clone
Clone a export, optionally remapping connections
Risk: write
object \| object[]
Output full type
Output full type
create
exports.create
Create a export
Risk: write
delete
exports.delete
Delete a export
Risk: destructive · Irreversible
get
exports.get
Get a export by id
Risk: read
getAudit
exports.getAudit
List audit log entries for a export
Risk: read
object[]
Output full type
Output full type
list
exports.list
List exports in the account
Risk: read
object[]
Output full type
Output full type
patch
exports.patch
Apply JSON Patch operations to a export
Risk: write
operations full type
operations full type
update
exports.update
Replace a export document. Send the full document; omitted fields are cleared
Risk: write
File Definitions
create
fileDefinitions.create
Create a file definition
Risk: write
get
fileDefinitions.get
Get a file definition by id
Risk: read
list
fileDefinitions.list
List EDI and fixed-width file definitions
Risk: read
object[]
Output full type
Output full type
Flows
clone
flows.clone
Clone a flow, optionally remapping connections
Risk: write
object \| object[]
Output full type
Output full type
create
flows.create
Create a flow
Risk: write
delete
flows.delete
Delete a flow
Risk: destructive · Irreversible
get
flows.get
Get a flow by id
Risk: read
getAudit
flows.getAudit
List audit log entries for a flow
Risk: read
object[]
Output full type
Output full type
getDependencies
flows.getDependencies
List resources that depend on a flow
Risk: read
Record<string, any>
getDescendants
flows.getDescendants
List the exports, imports and tools a flow uses
Risk: read
exports full type
exports full type
imports full type
imports full type
tools full type
tools full type
getLastExportDateTime
flows.getLastExportDateTime
Get when a flow last exported data
Risk: read
getLatestJobs
flows.getLatestJobs
Get the most recent jobs for a flow
Risk: read
object[]
Output full type
Output full type
getTemplate
flows.getTemplate
Get a signed URL to download a flow as a template zip
Risk: read
list
flows.list
List flows in the account
Risk: read
object[]
Output full type
Output full type
patch
flows.patch
Apply JSON Patch operations to a flow
Risk: write
operations full type
operations full type
update
flows.update
Replace a flow document. Send the full document; omitted fields are cleared
Risk: write
I Clients
create
iClients.create
Create an iClient
Risk: write
delete
iClients.delete
Delete an iClient
Risk: destructive · Irreversible
get
iClients.get
Get an iClient by id
Risk: read
list
iClients.list
List iClients (stored OAuth app credentials)
Risk: read
object[]
Output full type
Output full type
patch
iClients.patch
Patch an iClient. Celigo only allows replacing /oauth2/failPath
Risk: write
operations full type
operations full type
update
iClients.update
Replace an iClient document
Risk: write
Imports
clone
imports.clone
Clone a import, optionally remapping connections
Risk: write
object \| object[]
Output full type
Output full type
create
imports.create
Create a import
Risk: write
delete
imports.delete
Delete a import
Risk: destructive · Irreversible
get
imports.get
Get a import by id
Risk: read
getAudit
imports.getAudit
List audit log entries for a import
Risk: read
object[]
Output full type
Output full type
getDependencies
imports.getDependencies
List resources that depend on a import
Risk: read
Record<string, any>
invoke
imports.invoke
Run a saved import against the given records
Risk: write
object[]
Output full type
Output full type
list
imports.list
List imports in the account
Risk: read
object[]
Output full type
Output full type
patch
imports.patch
Apply JSON Patch operations to a import
Risk: write
operations full type
operations full type
update
imports.update
Replace a import document. Send the full document; omitted fields are cleared
Risk: write
Integrations
clone
integrations.clone
Clone a integration, optionally remapping connections
Risk: write
object \| object[]
Output full type
Output full type
create
integrations.create
Create a integration
Risk: write
createRevision
integrations.createRevision
Snapshot an integration as a new revision
Risk: write
delete
integrations.delete
Delete a integration
Risk: destructive · Irreversible
get
integrations.get
Get a integration by id
Risk: read
getAudit
integrations.getAudit
List audit log entries for a integration
Risk: read
object[]
Output full type
Output full type
getDependencies
integrations.getDependencies
List resources that depend on a integration
Risk: read
Record<string, any>
getTemplate
integrations.getTemplate
Get a signed URL to download an integration as a template zip
Risk: read
list
integrations.list
List integrations in the account
Risk: read
object[]
Output full type
Output full type
listConnections
integrations.listConnections
List the connections registered to an integration
Risk: read
object[]
Output full type
Output full type
listErrors
integrations.listErrors
Get open error counts per flow in an integration
Risk: read
object[]
Output full type
Output full type
listExports
integrations.listExports
List the exports in an integration
Risk: read
object[]
Output full type
Output full type
listFlows
integrations.listFlows
List the flows in an integration
Risk: read
object[]
Output full type
Output full type
listImports
integrations.listImports
List the imports in an integration
Risk: read
object[]
Output full type
Output full type
listUsers
integrations.listUsers
List the users shared on an integration
Risk: read
object[]
Output full type
Output full type
patch
integrations.patch
Apply JSON Patch operations to a integration
Risk: write
operations full type
operations full type
registerConnection
integrations.registerConnection
Register a connection to an integration
Risk: write
registerConnections
integrations.registerConnections
Register connections to an integration, one per request body (_connectionId)
Risk: write
unregisterConnection
integrations.unregisterConnection
Unregister a connection from an integration
Risk: destructive
update
integrations.update
Replace a integration document. Send the full document; omitted fields are cleared
Risk: write
Jobs
getErrors
jobs.getErrors
Get the errors of a job (up to 1000)
Risk: read
object[]
Output full type
Output full type
list
jobs.list
List jobs filtered by flow, integration, status, type or date
Risk: read
object[]
Output full type
Output full type
Processors
generateStructuredFile
processors.generateStructuredFile
Render JSON records as delimited or fixed-width text
Risk: read
rules full type
rules full type
parseCsv
processors.parseCsv
Parse CSV text into JSON records
Risk: read
options full type
options full type
parseStructuredFile
processors.parseStructuredFile
Parse EDI or fixed-width text into JSON using a file definition
Risk: read
parseXml
processors.parseXml
Parse XML text into JSON records
Risk: read
Scripts
create
scripts.create
Create a JavaScript hook script
Risk: write
delete
scripts.delete
Delete a script
Risk: destructive · Irreversible
get
scripts.get
Get a script by id
Risk: read
getLogs
scripts.getLogs
Get execution logs written by a script
Risk: read
update
scripts.update
Replace a script
Risk: write
State
delete
state.delete
Delete a global state key
Risk: destructive · Irreversible
deleteAll
state.deleteAll
Delete every global state key
Risk: destructive · Irreversible
deleteAllForResource
state.deleteAllForResource
Delete every state key on an export, import or integration
Risk: destructive · Irreversible
deleteForResource
state.deleteForResource
Delete a state key on an export, import or integration
Risk: destructive · Irreversible
get
state.get
Get the value stored under a global state key
Risk: read
Record<string, any> \| any[]
getForResource
state.getForResource
Get a state value stored on an export, import or integration
Risk: read
Record<string, any> \| any[]
list
state.list
List global state keys
Risk: read
listForResource
state.listForResource
List state keys stored on an export, import or integration
Risk: read
set
state.set
Create or replace the value under a global state key
Risk: write
setForResource
state.setForResource
Create or replace a state value on an export, import or integration
Risk: write
Tags
create
tags.create
Create an error tag
Risk: write
delete
tags.delete
Delete an error tag
Risk: destructive · Irreversible
get
tags.get
Get an error tag by id
Risk: read
list
tags.list
List error tags
Risk: read
object[]
Output full type
Output full type
update
tags.update
Rename an error tag
Risk: write
Users
delete
users.delete
Remove a user from the account
Risk: destructive · Irreversible
get
users.get
Get a user share by id
Risk: read
invite
users.invite
Invite one user by email with account or integration access
Risk: write
integrationAccessLevel full type
integrationAccessLevel full type
inviteMultiple
users.inviteMultiple
Invite several users by email with the same access
Risk: write
integrationAccessLevel full type
integrationAccessLevel full type
object[]
Output full type
Output full type
list
users.list
List users the account is shared with
Risk: read
object[]
Output full type
Output full type
update
users.update
Change a user share access level
Risk: write
integrationAccessLevel full type
integrationAccessLevel full type