Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

getTokenInfo

account.getTokenInfo Get the user id behind the current API token Risk: read
Input: empty object Output

listLicenses

account.listLicenses List the account licenses and subscriptions Risk: read
Input Output: object[]

Audit

list

audit.list List account audit log entries, newest first Risk: read
Input Output: object[]

Connections

create

connections.create Create a connection Risk: write
Input Output

delete

connections.delete Delete a connection Risk: destructive · Irreversible
Input Output

evaluateVirtualImportMap

connections.evaluateVirtualImportMap Run only the mapping step of an unsaved import and return the mapped records Risk: read
Input Output: any[] \| Record<string, any>

executeVirtualExport

connections.executeVirtualExport Run an unsaved export definition through a connection Risk: write
Input Output

executeVirtualExportPaged

connections.executeVirtualExportPaged Run an unsaved export one page at a time. Pass back pagedExportState for the next page Risk: write
Input Output

executeVirtualImport

connections.executeVirtualImport Send records through an unsaved import definition Risk: write
Input Output: object[]

get

connections.get Get a connection by id Risk: read
Input Output

getAudit

connections.getAudit List audit log entries for a connection Risk: read
Input Output: object[]

getDebugLogs

connections.getDebugLogs Get the debug log text recorded for a connection Risk: read
Input Output

getDependencies

connections.getDependencies List resources that depend on a connection Risk: read
Input Output: Record<string, any>

list

connections.list List connections in the account Risk: read
Input Output: object[]

patch

connections.patch Apply JSON Patch operations to a connection Risk: write
Input
Output

ping

connections.ping Test that a saved connection can reach its application Risk: read
Input Output: object

testVirtual

connections.testVirtual Test an unsaved connection document without storing it Risk: read
Input Output: object

update

connections.update Replace a connection document Risk: write
Input Output

Edi Profiles

list

ediProfiles.list List EDI trading partner profiles Risk: read
Input: empty object Output: object[]

Errors

assign

errors.assign Assign flow step errors to a user by email Risk: write
Input Output

deleteResolved

errors.deleteResolved Purge resolved errors from a flow step Risk: destructive · Irreversible
Input Output

list

errors.list List open errors for one export or import step of a flow Risk: read
Input Output

listResolved

errors.listResolved List resolved errors for one step of a flow Risk: read
Input Output

resolve

errors.resolve Mark errors on a flow step as resolved Risk: write
Input Output

retry

errors.retry Retry failed records on a flow step Risk: write
Input Output

updateTags

errors.updateTags Set tags on flow step errors Risk: write
Input
Output

Exports

clone

exports.clone Clone a export, optionally remapping connections Risk: write
Input Output: object \| object[]

create

exports.create Create a export Risk: write
Input Output

delete

exports.delete Delete a export Risk: destructive · Irreversible
Input Output

get

exports.get Get a export by id Risk: read
Input Output

getAudit

exports.getAudit List audit log entries for a export Risk: read
Input Output: object[]

list

exports.list List exports in the account Risk: read
Input Output: object[]

patch

exports.patch Apply JSON Patch operations to a export Risk: write
Input
Output

update

exports.update Replace a export document. Send the full document; omitted fields are cleared Risk: write
Input Output

File Definitions

create

fileDefinitions.create Create a file definition Risk: write
Input Output

get

fileDefinitions.get Get a file definition by id Risk: read
Input Output

list

fileDefinitions.list List EDI and fixed-width file definitions Risk: read
Input Output: object[]

Flows

clone

flows.clone Clone a flow, optionally remapping connections Risk: write
Input Output: object \| object[]

create

flows.create Create a flow Risk: write
Input Output

delete

flows.delete Delete a flow Risk: destructive · Irreversible
Input Output

get

flows.get Get a flow by id Risk: read
Input Output

getAudit

flows.getAudit List audit log entries for a flow Risk: read
Input Output: object[]

getDependencies

flows.getDependencies List resources that depend on a flow Risk: read
Input Output: Record<string, any>

getDescendants

flows.getDescendants List the exports, imports and tools a flow uses Risk: read
Input Output

getLastExportDateTime

flows.getLastExportDateTime Get when a flow last exported data Risk: read
Input Output

getLatestJobs

flows.getLatestJobs Get the most recent jobs for a flow Risk: read
Input Output: object[]

getTemplate

flows.getTemplate Get a signed URL to download a flow as a template zip Risk: read
Input Output

list

flows.list List flows in the account Risk: read
Input Output: object[]

patch

flows.patch Apply JSON Patch operations to a flow Risk: write
Input
Output

update

flows.update Replace a flow document. Send the full document; omitted fields are cleared Risk: write
Input Output

I Clients

create

iClients.create Create an iClient Risk: write
Input Output

delete

iClients.delete Delete an iClient Risk: destructive · Irreversible
Input Output

get

iClients.get Get an iClient by id Risk: read
Input Output

list

iClients.list List iClients (stored OAuth app credentials) Risk: read
Input Output: object[]

patch

iClients.patch Patch an iClient. Celigo only allows replacing /oauth2/failPath Risk: write
Input
Output

update

iClients.update Replace an iClient document Risk: write
Input Output

Imports

clone

imports.clone Clone a import, optionally remapping connections Risk: write
Input Output: object \| object[]

create

imports.create Create a import Risk: write
Input Output

delete

imports.delete Delete a import Risk: destructive · Irreversible
Input Output

get

imports.get Get a import by id Risk: read
Input Output

getAudit

imports.getAudit List audit log entries for a import Risk: read
Input Output: object[]

getDependencies

imports.getDependencies List resources that depend on a import Risk: read
Input Output: Record<string, any>

invoke

imports.invoke Run a saved import against the given records Risk: write
Input Output: object[]

list

imports.list List imports in the account Risk: read
Input Output: object[]

patch

imports.patch Apply JSON Patch operations to a import Risk: write
Input
Output

update

imports.update Replace a import document. Send the full document; omitted fields are cleared Risk: write
Input Output

Integrations

clone

integrations.clone Clone a integration, optionally remapping connections Risk: write
Input Output: object \| object[]

create

integrations.create Create a integration Risk: write
Input Output

createRevision

integrations.createRevision Snapshot an integration as a new revision Risk: write
Input Output

delete

integrations.delete Delete a integration Risk: destructive · Irreversible
Input Output

get

integrations.get Get a integration by id Risk: read
Input Output

getAudit

integrations.getAudit List audit log entries for a integration Risk: read
Input Output: object[]

getDependencies

integrations.getDependencies List resources that depend on a integration Risk: read
Input Output: Record<string, any>

getTemplate

integrations.getTemplate Get a signed URL to download an integration as a template zip Risk: read
Input Output

list

integrations.list List integrations in the account Risk: read
Input Output: object[]

listConnections

integrations.listConnections List the connections registered to an integration Risk: read
Input Output: object[]

listErrors

integrations.listErrors Get open error counts per flow in an integration Risk: read
Input Output: object[]

listExports

integrations.listExports List the exports in an integration Risk: read
Input Output: object[]

listFlows

integrations.listFlows List the flows in an integration Risk: read
Input Output: object[]

listImports

integrations.listImports List the imports in an integration Risk: read
Input Output: object[]

listUsers

integrations.listUsers List the users shared on an integration Risk: read
Input Output: object[]

patch

integrations.patch Apply JSON Patch operations to a integration Risk: write
Input
Output

registerConnection

integrations.registerConnection Register a connection to an integration Risk: write
Input Output

registerConnections

integrations.registerConnections Register connections to an integration, one per request body (_connectionId) Risk: write
Input Output

unregisterConnection

integrations.unregisterConnection Unregister a connection from an integration Risk: destructive
Input Output

update

integrations.update Replace a integration document. Send the full document; omitted fields are cleared Risk: write
Input Output

Jobs

getErrors

jobs.getErrors Get the errors of a job (up to 1000) Risk: read
Input Output: object[]

list

jobs.list List jobs filtered by flow, integration, status, type or date Risk: read
Input Output: object[]

Processors

generateStructuredFile

processors.generateStructuredFile Render JSON records as delimited or fixed-width text Risk: read
Input
Output

parseCsv

processors.parseCsv Parse CSV text into JSON records Risk: read
Input
Output

parseStructuredFile

processors.parseStructuredFile Parse EDI or fixed-width text into JSON using a file definition Risk: read
Input Output

parseXml

processors.parseXml Parse XML text into JSON records Risk: read
Input Output

Scripts

create

scripts.create Create a JavaScript hook script Risk: write
Input Output

delete

scripts.delete Delete a script Risk: destructive · Irreversible
Input Output

get

scripts.get Get a script by id Risk: read
Input Output

getLogs

scripts.getLogs Get execution logs written by a script Risk: read
Input Output

update

scripts.update Replace a script Risk: write
Input Output

State

delete

state.delete Delete a global state key Risk: destructive · Irreversible
Input Output

deleteAll

state.deleteAll Delete every global state key Risk: destructive · Irreversible
Input: empty object Output

deleteAllForResource

state.deleteAllForResource Delete every state key on an export, import or integration Risk: destructive · Irreversible
Input Output

deleteForResource

state.deleteForResource Delete a state key on an export, import or integration Risk: destructive · Irreversible
Input Output

get

state.get Get the value stored under a global state key Risk: read
Input Output: Record<string, any> \| any[]

getForResource

state.getForResource Get a state value stored on an export, import or integration Risk: read
Input Output: Record<string, any> \| any[]

list

state.list List global state keys Risk: read
Input: empty object Output

listForResource

state.listForResource List state keys stored on an export, import or integration Risk: read
Input Output

set

state.set Create or replace the value under a global state key Risk: write
Input Output

setForResource

state.setForResource Create or replace a state value on an export, import or integration Risk: write
Input Output

Tags

create

tags.create Create an error tag Risk: write
Input Output

delete

tags.delete Delete an error tag Risk: destructive · Irreversible
Input Output

get

tags.get Get an error tag by id Risk: read
Input Output

list

tags.list List error tags Risk: read
Input Output: object[]

update

tags.update Rename an error tag Risk: write
Input Output

Users

delete

users.delete Remove a user from the account Risk: destructive · Irreversible
Input Output

get

users.get Get a user share by id Risk: read
Input Output

invite

users.invite Invite one user by email with account or integration access Risk: write
Input
Output

inviteMultiple

users.inviteMultiple Invite several users by email with the same access Risk: write
Input
Output: object[]

list

users.list List users the account is shared with Risk: read
Input Output: object[]

update

users.update Change a user share access level Risk: write
Input
Output