Celigo integration: operations for AI agents
Celigo connects to Type.com as an integration. This page lists the 586 operations documented for Claude and Codex in Type.com: 307 read, 118 write, 161 destructive.
About Celigo
Integration platform as a service (iPaaS) for connecting applications and automating workflows
Categories: Developer Tools & IT
How to connect Celigo to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
586 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
586 operations listed.
Account
- Read
Resolve the current token's identity
Resolves the bearer token on the request to the account it belongs to, the credential it is, the user acting through it, and the environment it is bound to. Call it with the same token you use for other requests — there is no body and no query parameter.
- Read
List applications in use
Returns every external application that has at least one connection in the account, grouped with summaries of those connections.
On premise Agents
- Read
List on-premise agents
Returns all on-premise agents configured in the account. Check offline to determine agent health — true means the platform has not received a heartbeat recently.
- Read
Get an on-premise agent
Returns a single on-premise agent.
- Read
Display on-premise agent access token
Returns the current unmasked access token for an agent. The agent process needs this token to authenticate its tunnel back to integrator.io. The access token is not included in normal GET/PUT responses — this is the only way to retrieve it.
- Read
Get on-premise agent installer download URL
Returns a short-lived presigned S3 URL for downloading the on-premise agent installer binary. The URL is pre-signed for roughly 15 minutes. The os query parameter selects which installer to return: - linux → agent-linux.run - windows → agent-windows.exe
- Read
List dependencies of an agent
Returns resources that depend on this agent. Keys are resource types (e.g. connections); values are arrays of dependency entries. Check dependencies before deleting — the DELETE endpoint is blocked if dependents exist. Returns {} for both zero-dependency and nonexistent IDs.
- Write
Create an on-premise agent
Creates a new on-premise agent. Only name is required. The response includes the agent record but not the access token — call GET /v1/agents/{id}/display-token to retrieve the token needed for the agent installer.
- Destructive
Update an on-premise agent
Replaces an on-premise agent's mutable fields. Only name and description are mutable — system-managed fields (version, offline, port, etc.) are ignored on PUT.
- Destructive
Delete an on-premise agent
Deletes an on-premise agent. Soft-deleted and retained in the recycle bin for 30 days. Does not uninstall the agent software on the host. Connections using this agent's agentId will block deletion with 422 — check dependencies first.
- Destructive
Rotate on-premise agent access token
Regenerates the access token and returns the new value. The previous token is immediately invalidated — the running agent process will disconnect, so update the agent's configuration with the new token before it attempts to reconnect. This is irreversible.
AI Agents
- Read
List AI agents
Returns all imports in the account. The response includes every import type, not just AI agents — filter client-side by adaptorType: "AiAgentImport".
- Read
Get an AI agent
Returns the full configuration of a single AI agent import.
- Read
Preview and compare AI agent configurations
Runs one or more AI agent import configurations against the same input data and returns the LLM response, token usage, and timing for each. No job is created and no state is updated — this is a stateless preview.
- Read
List dependencies of an AI agent
Returns resources that depend on this AI agent import. Keys are resource types (e.g. flows); values are arrays of dependency entries. Check dependencies before deleting — the DELETE endpoint is blocked if dependents exist. Returns {} for both zero-dependency and nonexistent IDs.
- Read
List AI agents on affected models
Returns the AI agent and guardrail imports the caller can read whose configured model is refused (not in the catalog, switched off, not offered for the import's credential type, or retired) or deprecated.
- Read
List an integration's affected AI agents
Same rules as GET /v1/aiagents/aiModelHealth, then keeps only the imports a live flow of this integration references (as a page processor, inside a router branch, or as the flow's top-level import), each with the flows and integrations that use it.
- Write
Create an AI agent
Creates a new AI agent import. The provider decides the configuration format: aiAgent.openai for OpenAI, aiAgent.litellm for Gemini and Anthropic Claude, or the generic flat format (aiAgent.model, aiAgent.modelOptions, …) for the catalog providers Mistral, xAI, Hugging Face, Dee…
- Write
Chat with a saved AI agent
Sends one message to a saved AI agent and streams the answer as text/event-stream.
- Write
Chat with an unsaved AI agent document
Sends one message to an AI agent document carried in the request — a draft never saved, or a saved agent with unsaved changes — and streams the answer back as text/event-stream with the same events as POST /v1/imports/{id}/aiagents/chat (see ChatStreamEvent).
- Destructive
Update an AI agent
Replaces the full configuration of an AI agent import.
- Destructive
Delete an AI agent
Deletes an AI agent import. Soft-deleted and retained in the recycle bin for 30 days before permanent removal.
Alerts
- Read
List alerts
Returns proactive alerts for the account. Soft-deleted alerts are excluded. Requires permission get:alert:models. Returns 403 when the ENABLEPROACTIVEALERTS feature flag is off.
- Read
Get an alert
Returns a single proactive alert by id. Soft-deleted alerts return 404. Requires permission get:alert:model. Returns 403 when ENABLEPROACTIVEALERTS is off. With populate=true, nested flow / integration / recipient objects are returned; otherwise foreign keys are raw ObjectIds.
- Read
Get audit log for an alert
Returns the change history for an alert. Each entry records a mutation event with who made the change, when, and which fields were affected. Requires permission to read the alert (get:alert:model). Returns 403 when ENABLEPROACTIVEALERTS is off or the caller lacks access.
- Write
Create an alert
Creates a proactive alert. Validates type, flow/integration, and duplicate constraints, then resolves recipientEmails to recipientUserIds and dual-writes the long-runtime threshold onto the related flow document(s).
- Write
Bulk update alert recipients
Adds or removes recipients across many alerts in one call. Provide either alertIds or integrationId (not both). Both add and remove accept recipientEmails. Full success returns 204 with no body.
- Destructive
Update an alert
Replace-all update of threshold and recipients. type, flowId, and integrationId are immutable. Resolves recipientEmails the same way as create, then dual-writes the updated threshold to related flow(s). Requires permission put:alert:models.
- Destructive
Delete an alert
Soft-deletes an alert and clears longRuntimeThresholdMinutes on the related flow document(s), which moves each flow's lastModified. A deleted alert reads 404 and has no recycle-bin entry. Requires permission put:alert:models. Returns 403 when ENABLEPROACTIVEALERTS is off.
APIs
- Read
List APIs
Returns the APIs configured in the account, cursor-paginated via the Link header when limit is set. Legacy script-mode APIs (created before the builder/script distinction) may omit type, version, and disabled. A 204 response means nothing matched.
- Read
List month-to-date API invocation counts
Returns one invocation-counter record per resource + method + relativeURI in the current month.
- Read
List monthly API invocation totals
Returns one total per calendar month, newest first, summed across every environment in the account, alongside the invocations the subscription allowed for that month.
- Read
List current-month API usage per environment
Returns the current month's invocation counters for every environment in the account, including environments with no traffic. Counters reset on the first of each month.
- Read
Get an API
Returns the complete configuration of a specific API.
- Read
List recent request/response logs for an API
Returns the recent invocation traces captured for the named API. Each entry is a decoded request/response pair — masked for credentials — that the runtime stored when the API was called via its public endpoint.
- Read
Get one request/response log entry by key
Returns the full decoded request/response envelope for one API invocation, looked up by the opaque key values surfaced in GET /v1/apis/{id}/logs. Matches the exact entry whose key is provided — there is no partial-match or range query on this endpoint.
- Read
List API request run history (defaults to last 5 minutes)
Returns the logged request executions of a builder-mode API — one entry per inbound request to its public endpoint captured while the API's logging.mode was anything other than noLogging, including requests that failed before reaching a response step.
- Read
Get trace metadata for an API request execution
Returns the top-level execution steps for the trace view of one API request, in execution order: the request-parsing step (identified by the API's own id; omitted for requests logged in basic mode), one step per export or import the request passed through, and the response step…
- Read
List child records under an API trace step
Returns the child records under a parent record within an API request trace (lookup / one-to-many expansions). Results are cursor-paginated (next/prev).
- Read
Query decoded log data for an API trace step
Returns the decoded request/response payload and error metadata for a record/stage within an API request execution, identified by expOrImpId, stage, groupId, and recordId.
- Read
Get a signed URL for a stored API request log payload
Returns a short-lived signed S3 URL (five-minute expiry) for the provided s3Key suffix, taken from an externalReference returned by the log-data query endpoint.
- Read
List dependencies of an API
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Read
List connections an API depends on
Returns the connections referenced by the export and import steps in builder.routers, including connections a nested Tool step supplies through its overrides. Each connection appears once even when several steps share it.
- Read
Get a step's stages from an API test run
Returns the per-stage execution detail for a single step of a completed API test run. runId is the parent flowJob.id returned by POST /v1/apis/{id}/test/run, and stepId is the step id surfaced in that run's metadata map. Each entry in stages[] carries the stage name (e.g.
- Read
Get request/response captures for an API test-run step
Returns the request/response captures recorded for a single export or import step of an API test run. runId is the parent flowJob.id from POST /v1/apis/{id}/test/run, and stepId is the step id from that run's metadata map.
- Read
List captured requests for an API step
Returns the set of requests captured for a single step of an API. stepId identifies the step within the API's configuration. Each entry in requests[] is a captured request summary; follow up with GET /v1/apis/{id}/{stepId}/requests/{key} to retrieve one entry in full.
- Read
Get one captured request for an API step by key
Returns the full captured request/response envelope for one entry of an API step, looked up by the opaque key values surfaced in GET /v1/apis/{id}/{stepId}/requests. Matches the exact entry whose key is provided — there is no partial-match query on this endpoint.
- Read
Validate an API clone
Dry-run check for POST /v1/apis/{id}/clone. Verifies that cloning the API to the target version would not collide with an existing API route — the clone keeps the source API's method and relativeURI, so the target version + method + relativeURI combination must not conflict with…
- Read
Get a downloadable template for an API
Packages a builder-mode API as an installable template and returns a signed S3 URL where the template .zip can be downloaded. The URL is pre-signed and short-lived (approximately 15 minutes), so fetch the file promptly; call the endpoint again for a fresh URL.
- Write
Create an API
Creates a new API. For script mode, include script.scriptId and script.function (the server also copies these to the top level in the response).
- Write
Patch an API
Partially updates an API using a JSON Patch document (RFC 6902).
- Write
Test-run an API
Executes the API once in a sandboxed test harness without invoking its public endpoint, and returns the job tree produced by the run. Use this to validate a builder-mode API's request parsing, routing, and response mapping before exposing it externally.
- Write
Clone an API
Clones a builder-mode API along with the resources it depends on (such as its backing import) and returns a manifest of every resource created.
- Destructive
Update an API
Replaces the full API configuration. Send the complete object -- omitted fields revert to defaults, not their prior values. Read-only fields (id, createdAt, lastModified) in the request body are ignored.
- Destructive
Delete an API
Deletes an API. Soft-deleted and retained in the recycle bin for 30 days. The public endpoint stops responding immediately. The delete succeeds even with dependents, but those resources will break -- check GET /v1/apis/{id}/dependencies first.
- Destructive
Convert a JSON object to JSON Schema
Accepts a sample JSON object and returns its inferred JSON Schema definition. Useful for bootstrapping bodySchema in builder-mode APIs from real payload samples. Input must be a non-empty JSON object -- arrays and primitives are rejected.
- Destructive
Update the grouping for one or more APIs
Assigns or removes an API grouping for the specified API resources. Pass apiGroupingId: null or omit it to ungroup. Nonexistent API IDs are silently accepted. Every API in apiIds must belong to the same integration, and the grouping must be one of that integration's apiGroupings.
- Destructive
Delete API request logs in a date range
Queues asynchronous deletion of stored request log payloads for the API within [startedAt, endAt]. Returns 202 Accepted; cleanup runs in the background. Requires manage access for log deletion — monitor-level users receive 403.
- Destructive
Replace a connection across an API
Repoints every export and import step in builder.routers that uses connectionId to newConnectionId, saving each step resource in place, and returns how many steps changed.
APIM
- Read
Get APIM console redirect URL
Returns a signed URL that opens the APIM console home page for the account.
- Read
Get APIM analytics redirect URL
Returns a signed URL that opens the APIM analytics dashboard for the account. Optionally scope the dashboard to a time range with from and to.
- Read
Get APIM resource view URL
Returns a signed URL that opens a published resource in the APIM console.
- Read
List APIM APIs
Returns APIs published in the APIM platform for the account. Results are paginated with page and perPage.
- Read
Get APIM settings
Returns the APIM subdomain and service account email configured for the account.
- Write
Publish resource to new APIM API
Publishes an integrator.io resource to APIM as a new API. Requires apim:operations permission and an enabled APIM license. Custom webhooks (non-integrator-extension) are rejected with 400. Upstream API management errors may be returned with the upstream HTTP status.
- Write
Publish OpenAPI spec to APIM API
Publishes an OpenAPI specification to an existing APIM API. When a signed URL is not required for the resource type, the server generates the OpenAPI document from the resource. The resource must already be published to the given apiId (400 if not).
- Write
Set up APIM account
Provisions APIM for the account with a subdomain and service account email. Processing is asynchronous and returns 202 Accepted with an empty body. Production environment only. Requires apim:operations permission.
- Destructive
Publish resource to existing APIM API
Publishes an integrator.io resource to an existing APIM API. Requires apim:operations permission and an enabled APIM license. Upstream API management errors may be returned with the upstream HTTP status.
- Destructive
Update APIM account settings
Updates the service account email for an existing APIM account configuration. Production environment only. Requires apim:operations permission.
- Destructive
Validate APIM subdomain
Checks whether a subdomain is available for APIM account setup. Production environment only.
- Destructive
Validate APIM environment HRID
Checks whether an environment HRID is available for APIM configuration. Production environment only.
- Destructive
Resume APIM
Resumes APIM for the account after it has been paused or suspended. Production environment only. Requires manage:license permission (not apim:operations). Returns 204 even when APIM is not yet provisioned (no orgId on the user).
Async Helpers
- Read
List async helpers
Returns an array of all async helper resources in the account.
- Read
Get an async helper
Returns a single async helper resource by its ID.
- Read
List dependencies of an async helper
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries. Returns {} for both zero-dependency and nonexistent IDs.
- Write
Create an async helper
Creates a new async helper resource. The referenced http.status.exportId must be an existing export resource. If http.submit.sameAsStatus is false, also set http.submit.resourcePath to extract the async job identifier.
- Destructive
Update an async helper
Updates an existing async helper with the provided data. This is a full replacement — all required fields must be included in the request body.
- Destructive
Delete an async helper
Deletes an async helper. The resource is soft-deleted and retained in the recycle bin for 30 days before permanent removal. If other resources reference this async helper (e.g.
Audit Logs
- Read
Query audit logs
Search audit log entries across all resources in the current account. Use this to answer "what changed?" across the account — filter by resource type, user, source, action, or time range. Results are ordered newest-first.
- Read
Query audit logs with multi-select filters
The POST variant of the account-wide audit query, for filters the GET query string cannot express: each body filter is an array that matches entries with any of the listed values, and resourceName scopes results to an explicit list of resources.
- Read
Get signed URL to download audit logs CSV (all documents)
Generates a signed URL for downloading a CSV export of audit logs across all documents. The CSV columns are: Time, Source, User, Resource, Name/ID, Action, Field, Old value, New value, Support.
- Read
Get signed URL for audit CSV with multi-select filters
The POST variant of the CSV signed-URL download, accepting the same multi-select filter body as POST /v1/audit. The response is identical to the GET variant: a signed URL valid for ~15 minutes plus hasMore for batching.
- Read
Get audit log for a resource (and descendants)
Returns audit log entries for a specific resource and its descendants. For example, querying an integration returns changes to the integration, its flows, exports, imports, and connections. For account-wide searches, use GET /v1/audit instead.
- Read
Query a resource's audit log with multi-select filters
The POST variant of the resource-and-descendants audit query, accepting the same multi-select filter body as POST /v1/audit. Body filters apply within the resource's descendant set — e.g. filter an integration's audit trail to specific actions or sources.
- Read
Get signed URL to download audit logs CSV (for selected resources)
Generates a signed URL for downloading a CSV export of audit logs for specific resources and their descendants. The signed URL expires after 15 minutes. When hasMore is true, pass the last CSV row's timestamp as to in the request body to fetch the next batch.
Bar Tender Templates
- Read
List BarTender label templates
Returns Celigo-published BarTender catalog data. The catalog is read from S3 (catalog.json, written by the daily sync cron) and cached in-process. Omit name to get unique published template names (sorted).
- Read
Download a BarTender label template
Returns the published .btw binary for the named template. name must match a published catalog entry exactly — pipe-token alias matching from the list route is not applied here. The file is streamed as application/octet-stream with Content-Disposition: attachment.
Connections
- Read
List connections
Returns a list of all connections configured in the account. If no connections exist in the account, a 204 response with no body will be returned.
- Read
Get a connection
Retrieves a specific connection by its unique identifier. Returns the complete connection configuration including authentication settings.
- Read
Ping an existing connection via GET
GET variant of the saved-connection ping — identical behavior to POST /v1/connections/{id}/ping, with no request body to send.
- Read
Fetch debug logs for a connection
Returns the buffered debug log stream for the connection — request/response pairs from recent exports, imports, and lookups that used it.
- Read
Fetch a connection's debug logs for one export or import
Same buffered debug log stream as GET /v1/connections/{id}/debug, narrowed to the request/response pairs recorded for a single export or import (typeId) that uses the connection. Use it instead of filtering the shared stream client-side when one flow step is under investigation.
- Read
Get the authorization URL to re-authorize a connection
Returns a short-lived authorization URL for running (or re-running) the OAuth handshake behind this connection. Redirect the end user to it; once they consent, Celigo's callback writes the tokens back and flips needsAuthorization to false.
- Read
List dependencies of a connection
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries. Returns {} for both zero-dependency and nonexistent IDs.
- Read
Check the Celigo SuiteApp and bundle on a NetSuite connection
Reports, live from the connected NetSuite account, whether the Celigo integrator.io SuiteApp (SuiteScript 2.x) and the legacy Celigo bundle are installed — the check the UI runs before offering a NetSuite API version that depends on either.
- Read
Ping the distributed adaptor behind a connection
Pings, live, the Celigo distributed adaptor installed in the account behind a netsuite or salesforce connection — the integrator.io bundle or SuiteApp RESTlet in NetSuite, the Celigo managed package in Salesforce — and reports one combined result.
- Read
List sObject types for a Salesforce connection
Returns an array of all sObject type descriptors available on the given Salesforce connection. This is the Salesforce describe-global response, typically containing ~1058 sObject types.
- Read
Get sObject type detail for a Salesforce connection
Returns the full Salesforce sObject describe response for the specified sObject type on the given connection. This is a large payload that includes all fields, child relationships, record type info, URLs, and other metadata.
- Read
List record types for a NetSuite connection
Returns an array of all record types available via SuiteScript for the given NetSuite connection. The response typically contains ~539 record type descriptors. Pass ?refreshCache=true to bypass the server-side cache and fetch fresh metadata from NetSuite.
- Read
List fields for a NetSuite record type
Returns an array of field descriptors for the specified record type on the given NetSuite connection. Fields are grouped by category (e.g. Body Field) and include their data types.
- Read
List sublists for a NetSuite record type
Returns an array of sublists (line-item groups) available on the specified record type for the given NetSuite connection.
- Read
List saved searches for a NetSuite connection
Returns an array of saved searches available on the given NetSuite connection. The recordType query parameter is accepted but silently ignored by the server -- all saved searches are returned regardless.
- Write
Create a connection
Creates a new connection configuration that can be used to authenticate and connect to external systems and applications. To also register the new connection on one or more integrations in the same call, pass their ids in integrationIds.
- Write
Patch a connection
Partially updates a connection using a JSON Patch document (RFC 6902) without re-sending its credentials — stored credentials are never read, required, or changed by this operation.
- Write
Ping an existing connection
Runs the adaptor's ping routine against a saved connection to verify its credentials and network configuration still work; no data is read, written, or modified.
- Write
Send a request through a connection (proxy)
Sends one HTTP request to the system behind a saved connection, using that connection's base URI and stored authentication, and returns the target's response as-is.
- Write
Run an import document through a connection
Runs an import document sent in the request body — a virtual import — through this connection against the supplied records and returns one result per record, synchronously.
- Write
Run an export document through a connection
Runs an export document sent in the request body — a virtual export — through this connection against the live source and returns the fetched records, synchronously.
- Write
Run an import document through a connection as a step of a flow
Runs an import document sent in the request body — a virtual import — through the connection, with the flow and the integration in the path supplying the execution context a real run gives the step — hooks receive options.settings with the flow's and the integration's settings (…
- Write
Run an import document through a connection as a step of a tool
Runs an import document sent in the request body — a virtual import — through the connection, with the tool and the integration in the path supplying the execution context — hooks receive options.settings with the integration's settings (none when it carries none) plus integrati…
- Write
Run an import document through a connection as a step of an API
Runs an import document sent in the request body — a virtual import — through the connection, with the API and the integration in the path supplying the execution context — hooks receive options.settings with the integration's settings (none when it carries none) plus integratio…
- Destructive
Update a connection
Updates an existing connection configuration. This is a full-replace operation — send the complete connection document, not just the fields you want to change; a field omitted from the body is cleared.
- Destructive
Delete a connection
Deletes a connection. The connection is soft-deleted and retained in the recycle bin for 30 days before permanent removal. Use POST /v1/recycleBinTTL/connections/{id} to restore it during that window.
- Destructive
Clear the debug log buffer for a connection
Purges the connection's debug log buffer. Subsequent GET /v1/connections/{id}/debug calls return empty until new traffic is captured (assuming debugDate is still in the future).
- Destructive
Query metadata for a connection (RDBMS catalog or HTTP passthrough)
Fetches metadata from the system behind the connection. The request and response are bimodal, chosen by the connection's type: - rdbms / jdbc — runs a live catalog lookup. Send the rdbms wrapper (type: tables or columns).
- Destructive
Purge the message queue for a connection
Purges all messages from the connection's message queue. This is a rate-limited operation — repeated calls within approximately 20 seconds are throttled. Returns an empty response on success. If the queue is already empty, the request fails with an emptyconnectionqueue error.
Connectors
- Read
List connectors
Returns all connectors owned by the authenticated Partner account. Partner-only endpoint.
- Read
Get a connector
Returns a single connector by ID. Partner-only endpoint.
- Read
Get the install base for a connector
Returns the list of accounts that have installed this connector. Partner-only endpoint.
- Read
List licenses for a connector
Returns all licenses issued for this connector. Partner-only endpoint.
- Read
Get a license
Returns a specific license for a connector. Partner-only endpoint.
- Read
Preview a connector install
Returns a preview of what installing this connector would produce. The connector must be associated with an integration that has the install function configured.
- Write
Create a connector
Creates a new connector (Integration App). Partner-only endpoint.
- Write
Create a license for a connector
Creates a new license for a connector. Supply the target user's email address in the request body — the backend resolves it to a user account. If the email is not a registered integrator.io user, an invaliduser error is returned. Partner-only endpoint.
- Write
Install a connector (Integration App)
Triggers the install flow for a connector (Integration App). The connector must be associated with an integration that has the install function configured. Templates are installed via POST /v1/integrations/template/{id} instead.
- Destructive
Update a connector
Full-replaces a connector resource. Partner-only endpoint.
- Destructive
Delete a connector
Deletes a connector. This does not affect existing installations. Partner-only endpoint.
- Destructive
Push update to connector installations
Pushes an update to all (or specified) installations of this connector. Triggers the connector's updateFunction on each target integration. Partner-only endpoint.
- Destructive
Update a license
Updates an existing license for a connector (e.g. change expiry or edition). Partner-only endpoint.
- Destructive
Delete a license
Deletes a license for a connector. Partner-only endpoint.
EDI Profiles
- Read
List EDI profiles
Returns all EDI profiles configured in the account.
- Read
Get an EDI profile
Returns a specific EDI profile.
- Read
List dependencies of an EDI profile
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Write
Create an EDI profile
Creates a new EDI profile for EDI X12 or EDIFACT document exchange. fileType is immutable after creation. Only name and fileType are required; all ISA/GS/UNB control fields default to safe values.
- Destructive
Update an EDI profile
Updates an existing EDI profile. fileType cannot be changed after creation. Omitted fields are cleared to defaults.
- Destructive
Delete an EDI profile
Deletes an EDI profile. Soft-deleted and retained for 30 days.
EDI Transactions
- Read
Query the EDI transaction log
Returns EDI documents processed through B2B Manager flows, with envelope metadata (sender/receiver IDs, control numbers), document type, direction, and functional acknowledgement status. This is the data source behind the B2B Manager "Transactions" dashboard.
- Read
Get signed URL to download EDI transactions CSV
Exports EDI transaction-log records matching a lastModified date window to a CSV file and returns a short-lived pre-signed S3 URL for downloading it — the API equivalent of the B2B Manager dashboard's transaction download.
- Read
Get FA details for an EDI transaction
Returns functional acknowledgment (FA) details for a specific EDI transaction. FA details are only available for transactions with a "Rejected" status in B2B Manager.
- Read
Get a signed URL to download an EDI transaction file
Returns a short-lived pre-signed S3 URL for the primary EDI document (type=nonFa) or the functional-acknowledgement file (type=fa) of one EDI transaction record. Fetch the URL with a plain GET right away and never store it — request a new URL for a later download.
- Read
Get MDN details for an EDI transaction
Returns AS2 Message Disposition Notification (MDN) metadata for a specific EDI transaction record from the B2B Manager dashboard.
- Read
Download an EDI file by document number
Streams the raw EDI document whose business document number and document type match — the file an export parsed or an import generated. Acknowledgement files are not served here; use GET /v1/ediTransactions/{ediTransactionId}/ediFile?type=fa.
- Read
Download the latest EDI file matching filters
Streams the raw EDI document of the latest transaction (by lastModified) that matches the lookup filters — for callers that hold trading-partner context but no document number. The filters AND together and at least one must be sent.
- Write
Update part of an EDI transaction
Partially updates one or more EDI transaction records. Commonly used to update the faStatus field (functional acknowledgment status).
End Users
- Read
List end users
Returns the account's end users with identity fields (email, name, lastSignIn) joined from each user record, plus a computed hasWorkspaceShare flag indicating whether the same person also holds a workspace access record.
- Read
Get an end user's effective access
Compiles the end user's effective MCP server access — tools, APIs, prompts, and file resources — with source attribution: the union of direct grants, group grants, role grants, and permission sets. The result is recomputed on every request rather than cached.
- Read
Get an end user's connection
Returns one mcpChild connection — the credentials an end user supplied for a connection that an MCP server flagged requiresEndUserCredentials. Credentials are masked as on every connection read; there is no unmasked form.
- Write
Invite an end user
Finds or creates the user by email, creates an end-user access record, applies the requested group memberships and direct grants, and sends an invite email.
- Write
Invite end users in bulk
Invites 1–100 end users in one request, applying the same optional groupIds and directGrants to every invite. Processing is sequential and partial-success: a failed item never aborts the batch, so the response is HTTP 200 with a per-email result even when some items fail.
- Destructive
Revoke an end user
Soft-deletes the end-user access record and clears its group memberships; by the platform contract the mcpChild connections the end user holds on the account are invalidated with it. Any workspace access record the same person holds is unaffected.
- Destructive
Delete an end user's connection
Soft-deletes one mcpChild connection, so the end user must connect again before using tools that run through its parent.
- Destructive
Update an end user's access
Replaces the end user's group memberships and direct resource grants with the arrays sent. Works on invited end users before they accept. disabled is not applied here — use PUT /v1/ashares/{ashareId}/disable.
- Destructive
Toggle an end user's access
Toggles the disabled flag on the end user's access record — call again to restore access; there is no separate /enable path. Unlike the workspace toggle, this also works on invited end users who have not yet accepted.
Groups
- Read
List groups
Returns all active groups in the account. Requires account owner or administrator access.
- Read
Get a group
Retrieves a single group by ID.
- Write
Create a group
Creates a group for end-user access management. Group names must be unique within the account (case-insensitive), and any roleIds or resourceGrants.resourceId values must reference resources owned by the same account. Requires account owner or administrator access.
- Write
Add end users to a group
Bulk-adds up to 100 end users to the group as manual memberships. The operation is idempotent for end users already in the group. Requires account owner or administrator access.
- Destructive
Update a group
Replaces the group's writable fields; omitted fields are not preserved. A body with only name comes back with no description, resourceGrants: [] and roleIds: [], so the group grants its members nothing while their memberships stay.
- Destructive
Delete a group
Soft-deletes the group and removes the corresponding membership entry from every end user in the account. Requires account owner or administrator access.
- Destructive
Remove end users from a group
Bulk-removes manual memberships from the group. Only manual memberships can be removed this way — attempting to remove an IdP-synced membership returns 409; change the person's group in the identity provider (its group mapping or SCIM group assignment) instead.
Roles
- Read
List roles
Returns all active roles in the account. Requires account owner or administrator access.
- Read
Get a role
Retrieves a single role by ID.
- Write
Create a role
Creates a role. Role names must be unique within the account (case-insensitive), and resourceGrants.resourceId values must reference resources owned by the same account. Requires account owner or administrator access.
- Destructive
Update a role
Replaces the role's writable fields. Prefer resending the complete object — omitted fields are not preserved. Requires account owner or administrator access.
- Destructive
Delete a role
Soft-deletes the role and removes it from the roleIds of every group in the account. Requires account owner or administrator access.
Environments
- Read
List environments
Returns all environments in the account. Requires the environments feature to be enabled -- accounts without it receive featurenotenabled. Every account with the feature has at least one environment (Production). The full list is returned in a single unpaginated response.
- Read
Get an environment
Retrieves a single environment by ID.
- Write
Create an environment
Creates a new environment. The environment starts disabled; use the toggle endpoint to enable it. name is the only required field and must be unique within the account.
- Destructive
Update an environment
Replaces an environment's mutable fields (name, description, apim). To enable or disable an environment, use the toggle endpoint instead.
- Destructive
Toggle an environment on or off
Toggles the enabled state of an environment -- a disabled environment becomes enabled and vice versa. The Production environment cannot be disabled, and pending user invitations must be resolved before disabling any environment.
Event Reports
- Read
List event reports
Returns all event report objects for the account. No pagination or filtering is supported — query parameters like eventReportId, limit, and status are accepted but silently ignored.
- Read
Get an event report
Returns a single event report by ID. Check status for completed before attempting to download via the signed URL. The reportGenerationErrors array may contain per-flow errors even when the overall status is completed.
- Read
Get signed URL for an event report
Returns a pre-signed S3 URL for downloading the completed event report as a CSV file. The URL is valid for approximately 15 minutes. Only works when the report status is completed -- requesting it in any other status returns 400.
- Write
Create an event report
Queues generation of a new event report for the specified flows and time window. The report is created in queued status and transitions through running to completed (or canceled). startTime must be within the last 30 days and the span to endTime must not exceed 3 days.
- Destructive
Cancel an event report
Cancels a queued or running event report. The report's status transitions to canceled. No request body is needed. Idempotent for reports already in canceled status. A completed report cannot be canceled, and canceled reports cannot be resumed -- create a new one instead.
Exports
- Read
List exports
Returns a list of all exports configured in the account. If no exports exist in the account, a 204 response with no body will be returned.
- Read
Get an export
Returns the complete configuration of a specific export.
- Read
Preview the output of an export doc (no job created)
Runs an export doc through the flow engine's preview pipeline and returns the sample data it would have emitted, along with stage-by-stage diagnostics and any errors encountered. No Job record is created and no flow-level state is updated — this is a stateless preview.
- Read
Preview export data
Preview export data from a specific export within a flow. This endpoint allows you to preview the data that would be exported, including the exported data, URIs to the data in the source app, and processing stages information.
- Read
List dependencies of an export
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Write
Create an export
Creates a new export configuration that can be used to retrieve data from applications or external sources.
- Write
Patch an export
Partially updates an export using a JSON Patch document (RFC 6902).
- Write
Clone an export
Creates a copy of an existing export, remapping its connection through connectionMap. For an export that uses a connection, omitting the map or sending an empty one fails with 400 invalidconnectionMap; map the connection to itself to keep it.
- Write
Invoke an export and return its data
Runs an existing export end-to-end and returns its records (or errors) synchronously. Unlike POST /v1/flows/{id}/run, which starts a full flow job, this endpoint invokes a single export in isolation and returns the result directly in the response body.
- Destructive
Update an export
Updates an existing export with the provided configuration. This is used for major updates to an export's structure or behavior.
- Destructive
Delete an export
Deletes an export. The export is soft-deleted and retained in the recycle bin for 30 days before permanent removal. If the export is currently in use by any flows, those flows may fail until reconfigured.
- Destructive
Replace connection on export present in a flow
Replaces the connection used by an export in a flow and cancels any running jobs. This is useful when migrating flows between environments or updating to newer connection versions.
File Definitions
- Read
List file definitions
Returns file definitions configured in the account.
- Read
Get a file definition
Returns the complete configuration including parsing rules.
- Read
List dependencies of a file definition
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Write
Create a file definition
Creates a new file definition.
- Destructive
Update a file definition
Replaces the file definition with the provided configuration. This is a full replace -- include all fields you want to keep. format cannot be changed between fixed and delimited families after creation, and globalId is immutable for EDI formats.
- Destructive
Delete a file definition
Soft-deletes a file definition. Retained in the recycle bin for 30 days.
File Definition Rules
- Read
Poll an FDR generation job
Returns the job's current state. When status is completed, result carries parsingFdr and generationFdr; when failed, error carries the code and message. Non-administrators can only poll their own jobs. Job records expire after 24 hours (404 REQUESTNOTFOUND).
- Read
Poll an FDR parsing job
Returns the job's current state. When status is completed, result carries parsingFdr only; when failed, error carries the code and message. Non-administrators can only poll their own jobs. Job records expire after 24 hours (404 REQUESTNOTFOUND).
- Read
List supported document types
Returns the X12 transaction set numbers the generator supports (24 sets as of v1.2.0) and whether EDIFACT auto-detection is available (documentType: 0). Rate-limited to 100 requests per hour and 10 per 60 seconds per caller.
- Write
Submit an FDR generation job
Submits an async job that produces both parsing and generation FDR artifacts from the supplied EDI specification PDF. Returns a requestId immediately; poll GET /v1/filedefinitionrules/generate/{requestId} for status and results.
- Write
Submit an FDR parsing job
Submits an async job that produces a parsing FDR only (no generation artifact) from the supplied EDI specification PDF. Returns a requestId immediately; poll GET /v1/filedefinitionrules/parse/{requestId} for status and results.
File Server
- Read
Get the environment's file server
Returns the environment's SFTP file server: whether it is enabled, its permanent identifier, the shared endpoint and host-key fingerprints partners connect with, the loginFormat, and the effective limits.
- Read
List file server accounts
Returns the environment's partner accounts oldest first, wrapped in an accounts array, with overCap computed for each against the current limits.maxAccounts.
- Read
Get a file server account
Returns one partner account with overCap computed against the current cap. An id that is unknown, belongs to another environment, or is not a valid identifier all answer the same 404. Requires a full-access API token and a server that has been enabled at least once.
- Write
Create a file server account
Creates an enabled partner account with the given username, password, and Celigo Storage home folder, and returns it (the password is never returned).
- Write
Set or clear an account's password
Sets a new password for the partner account, or clears it when password is null. Clearing is refused while the account is enabled, because an enabled account must keep a credential — disable it first.
- Destructive
Enable or disable the file server
Enables the environment's file server — creating it, and claiming the permanent identifier, on the first call — or disables it. The body must carry enabled as a JSON boolean; anything else is refused rather than interpreted, because a disable ends every open partner session.
- Destructive
Update a file server account
Changes the fields sent and returns the account; fields left out keep their values, and {} returns the account unchanged without touching lastModified. Renaming keeps id and updates login.
- Destructive
Delete a file server account
Permanently removes the account and ends any session it has open. The home folder and its files are untouched, and the folder (with its ancestors) becomes deletable again through DELETE /v1/storage/items/{id}.
File Storage
- Read
Get a file download URL
Returns a short-lived presigned S3 URL for downloading a file's content, along with how many seconds it stays valid. Fetch the bytes directly from that URL — the content does not pass through this API. Files only; folders have no content to download.
- Read
Get a folder download URL
Packages a folder and everything beneath it into a zip and returns a short-lived presigned S3 URL to fetch it from — the content does not pass through this API.
- Read
List or search items
Browse or search Celigo Storage. In list mode (no search), returns the direct children of a folder — omit parentId for the account root — and includes a breadcrumb of the path to that folder.
- Read
Look up items in batch
Returns metadata for up to 100 items in one call. Send the item ids and optionally a fields projection; by default each result carries only id. Requesting path adds a breadcrumb path built from the item's ancestor folder names.
- Read
List recycle-bin items
Lists the items currently in the recycle bin, newest deletion first. Only items deleted directly are listed — descendants removed as part of a folder deletion are hidden, since they are restored or purged with their parent. Each item carries deletedAt and deletedBy.
- Read
Get audit log for a file
Returns the audit entries recorded for a file, newest first, or 204 with no body when it has none. File operations are no longer written to this audit log, so only entries recorded before that change are returned, and a file created since has none.
- Read
Get audit log for a folder
Returns the audit entries recorded for a folder, newest first, or 204 with no body when it has none. Folder operations are no longer written to this audit log, so only entries recorded before that change are returned, and a folder created since has none.
- Read
Get storage usage
Returns account-wide storage usage and entitlement, aggregated across all environments: bytes in use (active and recycle bin), the licensed quota, the hard limit at which uploads are blocked, and whether the account is in overage.
- Read
Get storage usage by environment
Returns storage usage per environment, with the account-wide total and the quota figures GET /v1/storage/usage reports. Use it to see which environment is consuming the account's shared quota.
- Write
Initiate file upload
Starts one or more file uploads. For each file, reserves quota, creates a pending item, and returns presigned S3 URLs to transfer the bytes to: a single PUT URL for files up to 5 GB, or a multipart uploadId, partUrls, and completeUrl for larger files.
- Write
Create a folder
Creates an empty folder. Folders are organizational only — they hold no content and do not count against storage quota. To create files, use POST /v1/storage/files/initiateUpload.
- Write
Move items in bulk
Moves up to 100 files or folders into one destination folder (or the account root) in a single call. Metadata only — content stays in place, ids are unchanged, and quota is unaffected. Folders re-parent immediately and re-anchor their descendants asynchronously.
- Write
Replace file content
Overwrites an existing file's content in place. Returns presigned upload URLs in the same shape as one initiate-upload file entry; transfer the new bytes to them just as for a new upload.
- Write
Merge a folder into another
Merges the contents of a source folder into an existing destination folder, then removes the source.
- Write
Move an item
Moves a file or folder to a different folder. Metadata only — the content stays in place, the item's id is unchanged so references survive, and quota is unaffected.
- Write
Copy a file
Creates an independent copy of a file in the folder named by parentId, with a new id and its own copy of the content. Consumes quota equal to the source file's size. Files only — folder copy is not supported.
- Write
Restore an item
Restores a soft-deleted item from the recycle bin back to its original location. Restoring a folder also restores the descendants that were removed with it; the folder comes back immediately and its descendants follow asynchronously.
- Destructive
Cancel a multipart upload
Aborts an in-progress multipart upload, discarding any uploaded parts and releasing the reserved quota. Use this to abandon a multipart upload started with POST /v1/storage/files/initiateUpload; single PUT uploads do not need canceling.
- Destructive
Rename or describe an item
Updates an item's name and/or description. Renaming keeps the item's id stable, so references from flows, exports, imports, and tokens survive; a name already held by another live item in the same folder is rejected with 409 STORAGEITEMALREADYEXISTS.
- Destructive
Delete an item
Soft-deletes a file or folder to the recycle bin, where it is retained for 30 days and can be restored with POST /v1/storage/items/{id}/restore. Deleting a folder also removes its entire subtree; the folder is removed immediately and its descendants follow asynchronously.
- Destructive
Purge an item
Permanently deletes a soft-deleted item from the recycle bin and frees its storage. This cannot be undone. Purging a folder also purges its descendants; the folder and its subtree are removed asynchronously.
Flows
- Read
List flows
Returns all flows in the account.
- Read
Get a flow
Returns the complete configuration of a flow, including its page generators, processors, routers, schedule, and all nested settings.
- Read
Preview cloning a flow
Returns a preview of resources that would be created by cloning this flow — the target flow and all transitive dependencies (connections, exports, imports, scripts, async helpers, lookup caches). No resources are created.
- Read
Get a flow's descendant resources
Returns the full resource objects for every import, export, and tool referenced by the flow.
- Read
Summarize open errors across a flow's steps
Returns a per-step count of currently open (unresolved) errors for the flow. Each entry carries the step id and its open-error count; entries with zero errors still appear so the caller sees the full step roster.
- Read
Get flow runtime chart stats
Returns historical runtime statistics and chart buckets for a single flow. Used by the proactive alerts UI to suggest and preview long-runtime thresholds. This is not the job-dashboard aggregate API. Dashboard totals live at POST /v1/flows/runs/stats (job spec).
- Read
Get a flow's trace-key patterns
Returns the trace-key pattern for each page generator in the flow. Trace keys are used to correlate source records with their downstream results in execution logs — they let you look up "what happened to record X" without scanning the full log.
- Read
Get the flow's delta checkpoint
Returns the flow-level "last export date/time" checkpoint — the most recent export timestamp across all generators (exports) in the flow. This value is what gets substituted into the {{lastExportDateTime}} Handlebars variable on the next delta run of any export in the flow.
- Read
List open errors on a flow step
Returns one page of currently-open (unresolved) errors for a single step (export or import) within a flow. The step id is the exportId / importId from the flow's pageGenerators[], pageProcessors[], or routers[].branches[].pageProcessors[].
- Read
Get a signed URL to download open errors as CSV
Returns a pre-signed S3 URL that streams all currently-open errors for a flow step as a CSV file. The URL expires after approximately 15 minutes. The CSV always includes a header row, even when the step has zero open errors.
- Read
List resolved errors on a flow step
Returns one page of already-resolved errors for a flow step (same shape as the open-errors listing).
- Read
Get a signed URL to download resolved errors as CSV
Returns a pre-signed S3 URL that streams all resolved errors for a flow step as a CSV file. The URL expires after approximately 15 minutes. The CSV always includes a header row, even when there are zero resolved errors.
- Read
Get the stored retry-data snapshot for an error
Returns the per-record snapshot the runtime captured at the moment of failure — the shape that POST .../retry re-feeds into the flow pipeline.
- Read
Get a signed URL to download file-type retry data
Returns a pre-signed S3 URL for downloading the raw retry data file associated with an error. This only works for file-type retry data (e.g. file-based exports/imports). For standard record-based retry data, use GET .../{ retryDataKey}/data instead.
- Read
Get the HTTP request/response for an errored record
Returns the decoded HTTP request and response the runtime captured at the moment an error occurred, looked up by the opaque reqAndResKey found on each error in GET .../errors.
- Read
List stored HTTP request/response traces for a flow step
Returns a paginated list of HTTP request/response trace metadata for a flow step, filtered by time window, status code, method, and/or pipeline stage.
- Read
Get a signed URL for an oversized request/response body
Returns a pre-signed S3 URL for downloading the full request or response body when it was too large to store inline in the trace record.
- Read
Search jobs within a flow by trace key
Searches for flow-run jobs that contain records matching a trace key prefix. Returns up to 1000 matching job objects — there is no pagination beyond that limit.
- Read
List execution log entries for a flow run
Returns one page of execution-log entries for a specific flow run — one entry per record-at-step (export or import).
- Read
Query execution-log metadata for a record-at-step
Returns per-step timing and outcome metadata for a single record as it traveled through a flow run. When the request includes traceKey, the response spans every step that shared that trace — typically the source export plus its downstream imports.
- Read
Get per-stage execution log data for a record
Returns the decoded log data for a single (step, stage) tuple within a flow run, such as the HTTP request and response a step sent or the input and output of its mapping or a script hook.
- Read
List child log records for a parent record
Returns one page of child log records for a specific parent record within a flow-run step. Child records represent sub-operations (e.g. individual batch items, lookup expansions, or retry attempts) spawned by the parent record during step processing.
- Read
Get per-stage detail for a flow test-run step
Returns the per-stage input, output, and errors captured for a single step of a flow test run. Each step runs through one or more named stages (e.g.
- Read
Get request/response logs for a flow test-run step
Returns the outbound HTTP request/response log pairs captured during a specific step of a flow test run.
- Read
Get static filter enum metadata for errors
Returns the static enumeration values used to filter errors across the platform. The response is not scoped to the authenticated user — every caller receives the same set of filter dimensions and allowed values.
- Read
Preview the output of a flow's page processor
Runs a flow's page generators and page processors through the preview pipeline and returns the record arriving at one page-processor node, with the upstream chain applied server-side.
- Read
List dependencies of a flow
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Write
Create a flow
Creates a new flow. Flows are created enabled (disabled: false) by default — set disabled: true on create if the flow is not ready to run. At minimum, provide name and integrationId.
- Write
Patch a flow
Partially updates a flow using a JSON Patch document (RFC 6902).
- Write
Clone a flow
Creates a copy of a flow along with all transitive dependencies (exports, imports, scripts). integrationId is required, and connectionMap is required when the flow references connections — map a connection id to itself to reuse it, or to a different id to remap.
- Write
Trigger a flow run
Queues an on-demand run of the flow and returns the parent job id. The run is asynchronous: the response returns as soon as the job is queued; use GET /v1/jobs/{id} (with the returned jobId) or GET /v1/flows/{id}/jobs/latest to poll for terminal status.
- Write
Retry errored records
Re-runs the per-record data snapshots captured when the listed errors occurred. Submitting the retry resolves the listed errors at once, before the retry job runs and whatever it does; a record that fails again comes back as a new open error.
- Write
Retry errored records with exponential back-off
Re-runs errored record snapshots using an exponential decay (back-off) strategy. Behaves like POST .../retry but schedules retries with increasing delays between attempts, reducing load on the target system during transient outages.
- Write
Test-run a flow
Executes the flow in test mode and returns the test-run metadata synchronously. Unlike POST /v1/flows/{id}/run (which queues an asynchronous production job), a test run executes inline against the flow's current configuration and records the per-step stages it produced.
- Destructive
Update a flow
Replaces the entire flow configuration. All fields not included in the request body are reset to defaults — this is a full replace, not a merge. Always GET the flow first, modify the response, and PUT back — sending a partial body erases omitted fields.
- Destructive
Delete a flow
Deletes a flow. Soft-deleted and retained in the recycle bin for 30 days. Scheduled executions are stopped and any running jobs are cancelled. Check GET /v1/flows/{id}/dependencies first — if other resources reference this flow, the delete is blocked.
- Destructive
Replace a connection across a flow
Replaces every occurrence of one connection with another across all exports, imports, and lookups in the flow. This is the recommended way to swap connections during environment promotion (e.g.
- Destructive
Assign flows to a flow group
Assigns one or more flows to a flow-grouping (section) within their integration.
- Destructive
Assign open errors to a user
Tags a batch of open errors with an assignee for triage workflows. The errors stay open — this does not resolve or retry them — they simply appear in the assignee's "my errors" view until another action moves them.
- Destructive
Remove assignment from open errors
Removes the assignee from a batch of open errors. The errors remain open — this is the inverse of PUT .../errors/assign. Non-existent error ids are silently ignored (no error raised).
- Destructive
Mark open errors as resolved
Moves a batch of currently-open errors to the resolved list. The underlying records are unchanged — no retry happens; this is purely an administrative state change used to clear the open-errors queue after a user has reviewed the failures and decided they're not actionable.
- Destructive
Permanently delete resolved errors
Permanently removes resolved error records from the account. Use when the retention window hasn't expired yet but you want to clear out the resolved list (e.g. after a one-time cleanup pass).
- Destructive
Update the stored retry-data snapshot for an error
Full-replace of the stored per-record snapshot. The body becomes the new payload that POST .../retry will feed back into the pipeline. Same envelope shape as the matching GET — send the whole object (not just data), optionally mutated.
- Destructive
Delete stored HTTP request/response traces by key
Permanently removes specific stored request+response pairs from the per-step trace cache. Despite the un-parameterized path, this is not a blanket purge — the request body must name the exact reqAndResKey values to delete (from the errors listing).
- Destructive
Set tags on a batch of errors
Full-replace per-error: for each (errorId, retryDataKey) in the body, the stored tag set is replaced with tagIds. Pass tagIds: [] to clear all tags from the listed errors. Tags are account-scoped short codes (from GET /v1/tags) — not free-form strings.
- Destructive
Delete execution logs for a flow within a time range
Asynchronously deletes execution-log entries for the flow that fall within the specified time range. Returns 202 Accepted with an empty body — the deletion runs in the background. Both startedAt and endAt are required query parameters and must be valid ISO 8601 datetime strings.
- Destructive
Cancel all running jobs for a flow
Cancels every currently running job for the specified flow. This is the flow-scoped equivalent of cancelling individual jobs via PUT /v1/jobs/{id} — it finds all in-progress jobs for the flow and requests cancellation in a single call. No request body is required.
- Destructive
Cancel a flow execution group
Cancels all remaining jobs in a flow execution group. Execution groups are created when multiple flows are triggered together (e.g. via integration-level run or chained flows) and share a common group identifier.
Guardrails
- Read
List guardrails
Returns all imports in the account, not just guardrails. Filter client-side by adaptorType: "GuardrailImport" to isolate guardrails.
- Read
Get a guardrail
Returns the complete configuration of a specific guardrail import. The id is from the imports collection — the same ID used for any import type.
- Read
List dependencies of a guardrail
Returns the set of resources that depend on the specified guardrail import. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries. An empty object {} means no other resources depend on the target.
- Write
Create a guardrail
Creates a new guardrail import. connectionId is only needed for BYOK aiagent guardrails.
- Destructive
Update a guardrail
Replaces the guardrail import with the provided configuration. This is a full replace -- include all fields you want to keep. adaptorType must remain GuardrailImport.
- Destructive
Delete a guardrail
Deletes a guardrail import. Soft-deleted and retained in the recycle bin for 30 days before permanent removal.
HTTP Connectors
- Read
List HTTP connectors
Returns all HTTP Connectors visible to the authenticated account. The list response is abridged -- it omits published, baseURIs, supportedBy, and other detail fields. Use the by-ID endpoint for the full object.
- Read
Get an HTTP connector
Retrieves the full HTTP Connector object including published, baseURIs, supportedBy, and version details omitted from the list endpoint.
- Read
Get form metadata catalog
Returns projected resource and endpoint summaries for one import or export plane. Import catalogs may include derived ignoreExisting, ignoreMissing, and isIdentifierPresent flags on endpoints. Export catalogs return endpoint { id, name } only.
- Read
Get resource and endpoint detail
Returns scoped httpConnectorResource and httpConnectorEndpoint documents for a single export/import endpoint, or a paired import create/update batch. Lookup endpoints may be inlined when they are published and belong to the same connector.
- Write
Create an HTTP connector
Creates a new HTTP Connector framework definition. name is required, along with either versions (flat connector) or apis (grouped connector).
- Destructive
Update an HTTP connector
Replaces the HTTP Connector with the provided fields.
- Destructive
Delete an HTTP connector
Permanently deletes an HTTP Connector and all its child resources and endpoints.
HTTP Connector Endpoints
- Read
List your HTTP Connector Endpoints
Returns the full HTTP Connector Endpoints owned by the account, across all of its connectors and resources, sorted by name.
- Read
Get one of your HTTP Connector Endpoints
Returns the full endpoint. The nested GET /v1/httpconnectors/{httpConnectorId}/{httpConnectorResourceId}/{id} returns the identical object and additionally reaches endpoints published by other partners; this route is limited to endpoints the account owns.
- Read
List a resource's HTTP Connector Endpoints
Returns the endpoints defined under the given HTTP Connector Resource — your own and, for resources published by other partners, their published endpoints — sorted by name. The whole list is returned in one response.
- Read
Get an HTTP connector endpoint
Retrieves the full HTTP Connector Endpoint including method, relativeURI, queryParameters, pathParameters, and supportedBy details omitted from the list endpoint — the same object GET /v1/httpconnectorendpoints/{id} returns, but this route also reaches endpoints published by oth…
- Write
Create an HTTP Connector Endpoint
Creates an operation under one or more of your HTTP Connector Resources. Create the resource first (POST /v1/httpconnectorresources) and list its id in httpConnectorResourceIds; supportedBy.type decides whether users build exports or imports on the endpoint.
- Destructive
Update an HTTP Connector Endpoint
Replaces the endpoint with the request body. Send the complete document — description, queryParameters, pathParameters, resourceFields, and the supportedBy details are cleared when left out and isMappingRequired / mergePostBodyToPagingPostBody revert to false, while published an…
- Destructive
Delete an HTTP Connector Endpoint
Deletes the endpoint. Refused while another endpoint still names it in supportedBy.lookupToIdentifyExisting.httpConnectorEndpointId — update or delete that endpoint first. Not recoverable through the recycle bin.
HTTP Connector Resources
- Read
List your HTTP Connector Resources
Returns the full HTTP Connector Resources owned by the account, across all of its connectors, sorted by name.
- Read
Get one of your HTTP Connector Resources
Returns the full resource. The nested GET /v1/httpconnectors/{httpConnectorId}/{id} returns the identical object and additionally reaches resources published by other partners; this route is limited to resources the account owns.
- Read
List a connector's HTTP Connector Resources
Returns the resources defined under the given HTTP Connector — your own and, for connectors published by other partners, their published resources — sorted by name. The whole list is returned in one response.
- Read
Get an HTTP connector resource
Retrieves a specific HTTP Connector Resource by its unique identifier — the same object GET /v1/httpconnectorresources/{id} returns, but this route also reaches resources published by other partners.
- Write
Create an HTTP Connector Resource
Creates a resource grouping under one of your HTTP Connectors. Create the connector first (POST /v1/httpconnectors) and pass its id as httpConnectorId; list the connector's versions[].id values in versionIds to make the resource available in those versions.
- Destructive
Update an HTTP Connector Resource
Replaces the resource with the request body. Send the complete document — versionIds, metadata, resourceFields, supportedBy, and the other optional fields are cleared when left out, while published and isRoot keep their stored values when omitted.
- Destructive
Delete an HTTP Connector Resource
Deletes the resource. Refused while any HTTP Connector Endpoint still lists it in httpConnectorResourceIds — delete or re-point those endpoints first. A connector likewise cannot be deleted while it still has resources. Not recoverable through the recycle bin.
I Clients
- Read
List iClients
Returns all iClients in the account. Does not paginate — all iClients are returned in a single response.
- Read
Get an iClient
Retrieves a single iClient by ID.
- Read
List dependencies of an iClient
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Write
Create an iClient
Creates a new iClient. The provider field is required and determines which credential sub-object must be populated.
- Write
Patch an iClient
Partially updates an iClient using JSON Patch (RFC 6902). Only /oauth2/failPath is patchable; use PUT for other field changes.
- Destructive
Update an iClient
Replaces an existing iClient; create one with POST /v1/iclients. All mutable fields must be provided — omitted fields are reset to defaults.
- Destructive
Delete an iClient
Permanently deletes an iClient. Blocked while any connection references it, including a deleted connection still in the recycle bin: purge that connection with DELETE /v1/recycleBinTTL/connections/{id} first.
Imports
- Read
List imports
Returns a list of all imports configured in the account. If no imports exist in the account, a 204 response with no body will be returned.
- Read
Get an import
Returns the complete configuration of a specific import.
- Read
Preview cloning an import
Returns a preview of the resources that would be created by cloning the specified import. The response includes the target import and any transitive dependencies (e.g. connections, scripts). No resources are created by this endpoint.
- Read
Preview the output of an import doc (no job created)
Runs an import doc through the flow engine's preview pipeline against supplied sample data and returns the per-stage output.
- Read
List dependencies of an import
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Write
Create an import
Creates a new import configuration that can be used to send data to applications or external destinations.
- Write
Patch an import
Partially updates an import using a JSON Patch document (RFC 6902).
- Write
Clone an import
Creates a copy of an existing import, remapping its connection through connectionMap. For an import that uses a connection, an empty map fails with 400 invalidconnectionMap; map the connection to itself to keep it.
- Write
Invoke an import with data and return per-record results
Runs an existing import against the destination system with the supplied data records and returns per-record results synchronously. The request body should contain a data array of records to import.
- Destructive
Update an import
Updates an existing import with the provided configuration. This is used for major updates to an import's structure or behavior.
- Destructive
Delete an import
Deletes an import. The import is soft-deleted and retained in the recycle bin for 30 days before permanent removal. If the import is currently in use by any flows, those flows may fail until reconfigured.
- Destructive
Replace connection on import for a branched flow
Replaces the connection used by an import in a flow and cancels any related running jobs. This is useful when migrating flows between environments or updating to newer connection versions.
- Destructive
Preview NetSuite import field mappings against sample data
Resolves a NetSuite import's Mapper 1.0 field mappings against supplied sample records and returns the mapped NetSuite record — the body fields (nlobjFieldIds) and sublists (nlobjSublistIds) that would be sent — without writing anything to NetSuite.
Integrations
- Read
List integrations
Returns all integrations in the account. Supports field projection via include/exclude.
- Read
Get an integration
Returns the full integration object.
- Read
Preview cloning an integration
Returns a preview of the resources that would be created by cloning the specified integration. The response includes the integration and all transitive dependencies — flows, connections, exports, imports, scripts, async helpers, lookup caches, and tools.
- Read
List revisions for an integration
Returns every revision entry (snapshots, pulls, reverts) for the integration, newest first. An integration with no revision history returns an empty response (204), not [].
- Read
Get a revision
Returns the full revision record. The list endpoint already surfaces every field, so this is primarily useful when you have a revisionId in hand (e.g. from a webhook, audit log, or external reference) and want to verify state without re-listing.
- Read
Diff a pull or revert revision
Returns the before/after diff for a pull or revert revision. The diff is materialized on pull and revert revisions and is retained on their completed state -- available for both inprogress and completed pull/revert revisions.
- Read
List a failed revision's errors
Returns the error records recorded while a pull or revert revision was being applied — the same list the Revisions tab shows for a failed revision.
- Read
Summarize open errors across an integration's flows
Returns a per-flow count of currently open (unresolved) errors for every flow in the integration. Flows with zero open errors still appear so callers see the full flow roster; lastErrorAt is only populated when numError 0.
- Read
List flows belonging to an integration
Returns a bare array of full flow objects for every flow in the integration. Each element is a complete flow resource, the same shape as GET /v1/flows/{id}.
- Read
List imports belonging to an integration
Returns a bare array of full import objects for every import in the integration. Each element is a complete import resource, the same shape as GET /v1/imports/{id}.
- Read
List exports belonging to an integration
Returns a bare array of full export objects for every export in the integration. Each element is a complete export resource, the same shape as GET /v1/exports/{id}.
- Read
List connections belonging to an integration
Returns a bare array of full connection objects for every connection registered to the integration. Each element is a complete connection resource, the same shape as GET /v1/connections/{id}.
- Read
List async helpers belonging to an integration
Returns a bare array of async-helper objects for every async helper registered to the integration. Each element is a complete async-helper resource, the same shape as GET /v1/asynchelpers/{id}.
- Read
List lookup caches registered to an integration
Returns a bare array of full lookup cache objects for every cache in the integration's registeredLookupCacheIds, sorted by name. Each element is the same shape as GET /v1/lookupcaches/{id}. Rejects unknown integration ids with a 404.
- Read
List topics registered to an integration
Returns a bare array of full topic objects for every topic in the integration's registeredTopicIds, sorted by name. Each element is the same shape as GET /v1/topics/{id}. Rejects unknown integration ids with a 404. The externalId filter of GET /v1/topics is not applied here.
- Read
Get integration tree metadata
Returns structural metadata for the integration and its child integrations.
- Read
Get a downloadable template for an integration
Packages the integration as an installable template and returns a signed S3 URL where the template .zip can be downloaded. The URL is pre-signed and short-lived (it expires shortly after issuance), so fetch the file promptly after calling this endpoint.
- Read
List dependencies of an integration
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Write
Create an integration
Creates a new integration. Only name is required — the server populates all other fields with defaults.
- Write
Patch an integration
Partially updates an integration using a JSON Patch document (RFC 6902).
- Write
Clone an integration
Creates a standalone copy of an existing integration: the copy records its source in sourceId but isn't lifecycle-linked to it, so a pull between the two finds no changes.
- Write
Create a snapshot revision
Takes a point-in-time snapshot of the integration's current state and writes it to the revision history. The returned revision has type: snapshot and status: completed immediately -- snapshots are synchronous and do not require an apply step.
- Write
Create a lookup cache and register it
Creates a lookup cache exactly as POST /v1/lookupcaches does and, in the same call, adds it to the integration's registeredLookupCacheIds and an aliases[] entry whose alias is a slug of the cache name — the same side effect as the register operations.
- Write
Create a topic and register it
Creates a topic exactly as POST /v1/topics does and, in the same call, adds it to the integration's registeredTopicIds.
- Write
Change the edition of an Integration App integration
Triggers an edition change for an Integration App integration that has a changeEdition function configured. Requires the integration to belong to an Integration App with edition support.
- Write
Initialize a child integration
Initializes a child integration under an Integration App parent. Requires the parent integration to belong to an Integration App with an init script configured.
- Destructive
Update an integration
Replaces the integration's mutable fields. Send the full object -- omitted fields revert to defaults. GET the integration first, modify the fields you need, then PUT back. For partial updates to settings, flowGroupings, or apiGroupings, prefer PATCH with JSON Patch instead.
- Destructive
Delete an integration
Deletes an integration. The integration is soft-deleted and retained in the recycle bin for 30 days before permanent removal. Delete the flows, syncs, APIs and Tools it contains, and remove its aliases that point at lookup caches, first.
- Destructive
(Legacy) Assign open errors to a user across an integration
Tags a batch of open errors with an assignee. Errors stay open; this does not resolve or retry them. The email must resolve to a user with access to the account.
- Destructive
Register a connection to an integration (by path)
Registers a single connection to the integration by specifying the connection id in the URL path. No request body is needed. To unregister, use DELETE on the same path. Alternatively, use PUT /v1/integrations/{id}/connections/register to register by request body.
- Destructive
Unregister a connection from an integration
Removes a connection's registration from the integration. This does not delete the connection itself -- it only removes it from the integration's registered-connections list. Fails while any resource in the integration still uses the connection.
- Destructive
Register a connection to an integration (by body)
Registers a single connection to the integration by passing the connection id in the request body. Alternatively, use PUT /v1/integrations/{id}/connections/{connectionId}/register to register by path parameter.
- Destructive
Register a lookup cache to an integration (by path)
Registers a single lookup cache to the integration by specifying the lookup cache id in the URL path. No request body is needed. To unregister, use DELETE on the same path.
- Destructive
Unregister a lookup cache from an integration
Removes a lookup cache's registration from the integration. This does not delete the lookup cache itself — it only removes it from the integration's registeredLookupCacheIds list.
- Destructive
Register lookup caches to an integration (by body)
Registers one or more lookup caches to the integration, adding them to its registeredLookupCacheIds list. The request body is a bare JSON array of lookup cache ids; duplicates are collapsed.
- Destructive
Register a topic to an integration (by path)
Adds a single topic to the integration's registeredTopicIds so flows in the integration can subscribe to or publish on it. No request body is needed; registering an already-registered topic succeeds without duplicating it.
- Destructive
Unregister a topic from an integration
Removes a topic's registration from the integration. This does not delete the topic — it only removes it from the integration's registeredTopicIds.
- Destructive
Register topics to an integration (by body)
Adds one or more topics to the integration's registeredTopicIds. The request body is a bare JSON array of topic ids; duplicates and already-registered ids are collapsed, and an empty array is accepted as a no-op.
- Destructive
Resume an Integration App integration
Resumes a paused Integration App integration. Requires that the integration belongs to an Integration App. No request body is needed.
- Destructive
Detach the license from an integration
Detaches the license from an integration. Idempotent -- calling it on an integration that already has no license attached is a no-op. No request body is needed.
Jobs
- Read
List all jobs
Returns jobs matching the given query-parameter filters, up to 1001 per page in descending createdAt order. Use createdAtlte on the last record's createdAt (minus 1 ms) to page forward.
- Read
List in-progress jobs (dashboard)
Returns a paginated list of currently in-progress jobs for the dashboard -- jobs whose status is one of queued, running, or canceling. Jobs that have reached a terminal state (completed, failed, canceled, retried) are not returned; use POST /v1/flows/runs/stats for run history.
- Read
Get per-flow run statistics (dashboard aggregates)
Returns per-flow aggregate run statistics — one element of stats[] per flow that has at least one run matching the request filter.
- Read
Get a job
Returns a single job record. Works for both parent jobs (type=flow, retry, bulkretry) and child jobs (type=export, type=import). For the full parent+children view of a flow run, use GET /v1/jobs/{id}/family instead. For a multi-job lookup, use POST /v1/jobs/family.
- Read
Get a job and its children
Returns a single job record (as parent) with all of its child jobs inlined under children. A "job family" maps to one flow execution: the parent is a type: "flow" job and the children are the export / import / retry jobs that ran as part of it.
- Read
Get signed URL(s) to download job files
Returns short-lived S3 pre-signed URLs for downloading files produced by the job (e.g. the rows exported to a CSV, an error-record dump, or a page-processor artifact). The URLs are typically valid for ~15 minutes.
- Read
Get a signed URL for job diagnostics
Returns a short-lived S3 pre-signed URL pointing to a diagnostic archive (.zip) for the given job. The archive contains server-side traces/logs that Celigo support uses to debug execution failures. The URL is typically valid for ~15 minutes (enforced by S3).
- Read
Get the most recent job(s) for a flow
Returns the most recent job record(s) for the given flow. Typically one entry (the latest flow run), though the platform may include related retry jobs depending on account configuration. For a richer parent+children view, feed the returned id into GET /v1/jobs/{id}/family.
- Read
Get the most recent job(s) for an integration
Returns the most recent job record(s) across all flows in the given integration. Useful for a top-level status check on an integration. The result is not filtered by status -- inspect each entry's status to distinguish success from failure.
- Write
Batch-fetch job families
Returns job families for an array of job ids, in one request. Each item in the response array has the same shape as a single GET /v1/jobs/{id}/family call (a parent job with inlined children). Size limit: 1000 ids per request.
- Destructive
Cancel a job
Requests cancellation of a running or queued job. The job's status transitions to canceling and, once the platform has stopped in-flight work, to canceled. This is not synchronous — the response returns the updated job record with status: "canceling"; consumers should poll (e.g.
- Destructive
Purge a job's stored files
Deletes all file artifacts associated with the job (exported rows, error-record dumps, page-processor artifacts, etc.) from underlying storage.
Lookup Caches
- Read
List lookup caches
Returns lookup caches in the account.
- Read
Get a lookup cache
Returns configuration, metadata, and current size of a lookup cache. This returns metadata only — to read the cached key-value data, use POST /v1/lookupcaches/{id}/getData.
- Read
Preview cloning a lookup cache
Returns resources that would be created by cloning this cache. Lookup caches have no transitive dependencies, so the response contains only the cache itself. No resources are created.
- Read
Read entries from a lookup cache
Returns entries stored in a lookup cache. Called as POST (not GET) so the query — explicit keys or a prefix — can travel in the request body. Body variants: - omitted or {} → first page of all entries (up to ~1000, unordered). - {keys: [...]} → one entry per requested key.
- Read
List dependencies of a lookup cache
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Write
Create a lookup cache
Creates a new empty lookup cache. Populate it afterwards via POST /v1/lookupcaches/{id}/data.
- Write
Patch a lookup cache
Partially updates a lookup cache using a JSON Patch document (RFC 6902). Only replace is supported, on these paths: | Path | Description | |------|-------------| | /name | Cache display name | | /description | Cache description | All other paths or operations are rejected.
- Write
Upsert entries into a lookup cache
Writes key-value entries to a lookup cache. Keys that already exist are overwritten; new keys are created.
- Destructive
Update a lookup cache
Replaces the cache's writable fields. Read-only fields (id, userId, size, sizeInMB, timestamps) are silently ignored. To write cached data, use POST /v1/lookupcaches/{id}/data.
- Destructive
Delete a lookup cache
Soft-deletes a lookup cache and all its data. Retained for 30 days before permanent removal. To clear data without deleting the cache itself, use DELETE /v1/lookupcaches/{id}/data/purge instead.
- Destructive
Delete specific keys from a lookup cache
Removes named keys from a lookup cache. Send the keys to delete in the request body. To wipe every entry instead, call DELETE /v1/lookupcaches/{id}/data/purge. Send the request with Content-Type: application/json.
- Destructive
Purge all data from a lookup cache
Removes every entry from a lookup cache. The cache itself is preserved — only its contents are cleared. Use this instead of deleting-and-recreating when you want to keep the cache's id, name, and any references from flows intact. This operation is irreversible.
Marketplace
- Read
List published Templates
Returns the marketplace catalog of published Templates — the Template-only counterpart of GET /v1/published (Integration Apps only). Every entry carries type, which tells you whether the template installs an integration or an MCP server and therefore which install route to call.
- Read
Preview a template's installed resource docs
Returns the concrete resource documents a template would create if installed. The response is an envelope {type, objects, stackRequired} where objects is an array of {model, doc} entries — one per resource that the install step would materialize.
- Read
List published Integration Apps (Connectors)
Returns the marketplace catalog of Integration Apps — the Celigo-built, fully-managed connectors that install as a single integration. Roughly 30 entries curated by Celigo.
- Read
List Integration Apps and Templates together
Returns a unified array of marketplace content — both Integration Apps (docType: Connector) and Templates (docType: Template).
MCP OAuth Providers
- Read
List MCP OAuth providers
Returns all MCP OAuth providers in the account. Field projection via include / exclude is not supported for this resource. Passing either query param returns 422 invalidqueryparams (Include or exclude query params are not applicable for mcpoauthproviders resource).
- Read
Get an MCP OAuth provider
Returns the full configuration of an MCP OAuth provider.
- Write
Create an MCP OAuth provider
Creates a reusable OAuth provider that MCP servers can reference via mcpOAuthProviderId. name, issuerURL, and audience are required. Set useIntrospection: true with clientId/clientSecret to support opaque (non-JWT) tokens.
- Destructive
Update an MCP OAuth provider
Full replacement of an MCP OAuth provider's configuration -- include all fields, not just the ones you want to change. Send clientSecret: "" to preserve the existing secret. Changes propagate to all MCP servers referencing this provider.
- Destructive
Delete an MCP OAuth provider
Deletes an MCP OAuth provider. MCP servers referencing this provider via mcpOAuthProviderId will lose their OAuth configuration.
MCP Servers
- Read
List MCP servers
Returns all MCP servers in the account.
- Read
Get MCP request log filter options
Returns the filter values to offer for GET /v1/mcpservers/{id}/logs: the JSON-RPC methods to pick from and the closed set of status outcomes.
- Read
Get an MCP server
Returns the full configuration of an MCP server including tools, APIs, prompts, resources, connections, upstream MCP connections, and OAuth settings.
- Read
Export an MCP server as a template ZIP
Generates a template ZIP from the MCP server and returns a temporary signed URL for downloading it.
- Read
List dependencies of an MCP server
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries.
- Read
Get effective end-user access for an MCP server
Server-scoped reverse lookup: finds every end user who can reach this MCP server and compiles each one's effective access — tools, APIs, prompts, and file resources — with source attribution: the union of direct grants, group grants, role grants, and permission sets.
- Read
List connections used by an MCP server
Returns the connections attached to the server as full Connection documents, sorted by name.
- Read
List MCP server request logs
Lists the MCP JSON-RPC requests this server handled, newest first, 50 per page. Follow nextPageURL for the next page. Entries are summaries; when hasPayload is true, read the stored request and response with GET /v1/mcpservers/{id}/logs/{key}.
- Read
Get an MCP server request log
Returns the stored request and response for one MCP request, looked up by a key from GET /v1/mcpservers/{id}/logs. Only entries with hasPayload true have a key.
- Write
Create an MCP server
Creates an MCP server. The server is created disabled by default. name and relativeURI are the only required fields; relativeURI must be unique per account.
- Write
Patch an MCP server
Partially updates an MCP server using a JSON Patch document (RFC 6902).
- Write
Install a published MCP server template
Installs a published MCP-server marketplace template (a template whose type is mcpserver).
- Destructive
Update an MCP server
Full replacement of an MCP server's configuration. Omitted arrays (connections, tools, apis, prompts, resources, permissionSets, policies) are cleared, so include the complete arrays — clearing permissionSets this way also rewrites the pset: grants that referenced the erased set…
- Destructive
Delete an MCP server
Soft-deletes an MCP server. Retained in the recycle bin for 30 days before permanent removal.
- Destructive
Bulk assign MCP server access to end users
Assigns this server's capabilities to up to 100 end users in one request. For each end user, the grant for this server is replaced with the supplied capabilities; grants for other MCP servers and wildcard grants are preserved.
- Destructive
Bulk assign MCP server access to groups
Assigns this server's capabilities to up to 100 groups in one request. For each group, the grant for this server is replaced with the supplied capabilities; grants for other MCP servers and wildcard grants are preserved, and the group's roles and members are not changed.
- Destructive
Purge MCP server request log payloads
Permanently deletes the stored request/response payloads of this server's requests recorded between timegte and timelte, both inclusive. The listing rows stay in GET /v1/mcpservers/{id}/logs with hasPayload false.
Network Policies
- Read
List network policies
Returns the policies of the caller's environment, most recently modified first. Policies in the recycle bin are not included. The include and exclude projection parameters used by other list endpoints are not supported here.
- Read
Get a network policy
Returns a single policy from the caller's environment. A policy that has been moved to the recycle bin, or that belongs to another environment, returns 404.
- Read
List assignments of a network policy
Returns every API token, MCP server, and account sign-in setting the policy is assigned to within its own environment. Call it before DELETE to see what a force=true delete would clear.
- Read
Get audit log for a network policy
Returns the change history for a network policy, newest first. Each entry records one event with who made the change, when, and which fields were affected.
- Write
Create a network policy
Creates a policy in the caller's environment. Entries in both lists are validated and stored in normalized form — a bare address becomes /32 or /128, IPv6 is compressed — and the response shows the stored values.
- Write
Patch a network policy
Partially updates a policy with a JSON Patch document (RFC 6902). Fields the document does not touch are preserved, unlike PUT.
- Destructive
Replace a network policy
Replaces the policy with the request body. Fields left out are cleared: an omitted description is removed and an omitted ipAllowList or ipDenyList becomes empty, which lifts every restriction that list imposed. Entries are validated and normalized exactly as on create.
- Destructive
Delete a network policy
Moves the policy to the recycle bin, where it is retained for 30 days and can be restored. A policy that is still assigned to an API token, MCP server, or account sign-in setting is not deleted: the request fails with 409 networkpolicyinuse and info lists every assignment.
Notifications
- Read
List notification subscriptions
Returns notification subscriptions for flows, connections, integrations, and syncs in the account. Without the users=all query parameter, the response is scoped to the caller's own subscriptions. With users=all, every user's subscriptions in the account are returned.
- Destructive
Subscribe / unsubscribe users to resource notifications
Upserts a batch of notification subscriptions. Each item targets exactly one resource (flowId, connectionId, or integrationId) plus a subscribedByUserEmail. subscribed: true creates (or keeps) the subscription; subscribed: false removes it.
Parsers & Generators
- Read
List available flow processor types
Returns the catalog of processor types the flow engine supports — filter, transform, handlebars, javascript, mapper, CSV/XML parser / generator, branch filter, merge, etc. Each entry carries a label, description, and the input/output media types the processor accepts.
- Write
Convert XML to JSON
Parses XML data into JSON records using the specified parsing rules and resource path. Resource path format — Use XPath-style slash-separated paths (e.g. /root/item). Dot-separated paths (e.g. root.item) do not work.
- Write
Convert CSV to JSON
Parses CSV data into JSON records using the specified delimiter and formatting rules. Both data and rules are technically optional — omitting either returns an empty result rather than an error. When hasHeaderRow is false, columns are named Column0, Column1, etc.
- Write
Generate CSV from JSON
Generates CSV output from JSON records using the specified delimiter and formatting rules. The response always has mediaType: "text" and does not include dataRecordTraceKeys or traceKeysDuplicate. This is a stateless transformation.
- Write
Parse structured file (EDI) to JSON
Parses EDI or other structured/delimited file data into JSON using a file definition (parsing rules). Commonly used for X12 and EDIFACT documents. The file definition must be provided inside a rules.fileDefinition wrapper object, or referenced by ID via rules.fileDefinitionId.
- Write
Generate structured file (EDI) from JSON
Generates EDI or other structured/delimited file content from JSON records using a file definition (generation rules). Commonly used for producing X12 and EDIFACT documents.
- Write
Test filter rules against records
Evaluates export and import filter rules (Filter.expression) against the records in data and returns the records that pass. Nothing is saved and no flow runs, so it checks a rule before the rule is saved on a step.
- Write
Render a Handlebars template
Renders a Handlebars template against the object in data and returns the result. Nothing is saved and no flow runs, so it tests a template or a helper before the template is saved on a step. data is the template's root context: {{name}} reads data.name.
Profile
- Read
Get current user preferences
Returns UI and account/environment preferences for the currently-authenticated user. Examples include: - date/time display formatting (dateFormat, timeFormat) - current environment selection (environment) - UI layout preferences (dashboard/pagination/drawer settings)
- Destructive
Update current user preferences
Updates user preferences for the currently-authenticated user. Only include fields you intend to change.
Recycle Bin
- Read
List deleted resources
Returns all resources deleted within the last 30 days, across all resource types. Files and folders deleted from Celigo Storage are included as StorageItem entries. Sorted by lastModified descending. Not paginated — the full result set is returned in a single response.
- Read
List deleted resources by type
Returns deleted resources of a specific type from the recycle bin (last 30 days). Sort order is not guaranteed. Not paginated — the full result set is returned in a single response.
- Read
Get a deleted resource
Returns the full document of a specific deleted resource from the recycle bin. May include fields that the list endpoints omit (e.g. content on scripts, queues on connections).
- Write
Restore a deleted resource
Restores a single resource from the recycle bin back to the account's active resources. Any request body is ignored. Standalone restore is blocked if a child resource is still in the recycle bin.
- Write
Cascade-restore a deleted resource
Restores a resource from the recycle bin along with all of its dependent resources (child flows, exports, imports, connections, scripts, etc.). Any request body is ignored. Prefer this over standalone restore when restoring integrations or flows.
- Destructive
Permanently delete a resource
Permanently purges a resource from the recycle bin. This action cannot be undone — the resource data is irrecoverably removed. Resources are auto-purged after 30 days.
Scripts
- Read
List scripts
Returns all scripts in the account. Response omits content to reduce payload size.
- Read
Get a script
Returns a single script by ID, including the full content field.
- Read
Get execution logs for a script
Returns the script's execution log — the entries its console. calls wrote during real runs of the flows, APIs and Tools whose steps use the script.
- Read
Get audit log for a script
Returns the change history for a script. Each entry records a mutation event with who made the change, when, and which fields were affected.
- Read
List dependencies of a script
Returns the set of resources that depend on the specified script.
- Write
Create a script
Creates a new script.
- Write
Patch a script
Partially updates a script using JSON Patch (RFC 6902). Only /debugUntil is a supported path — all others are rejected with 422. Supported operations: replace, add, remove. The value must be an ISO-8601 timestamp no more than 1 hour in the future.
- Destructive
Update a script
Replaces a script's mutable fields. Send name on every update: a body whose name is missing or empty is refused with 422 invalidscript and nothing is saved.
- Destructive
Delete a script
Deletes a script. Soft-deleted and retained in the recycle bin for 30 days.
- Destructive
Delete execution logs for a script
Deletes every entry in the script's execution log — the same action as the script page's Clear logs. Synchronous and idempotent; succeeds when the script has no entries. The only way, apart from account retention, that entries leave the log.
Stacks
- Read
List stacks
Returns all stacks configured in the account.
- Read
Get a stack
Returns a single stack by ID.
- Read
Get stack system token (server stacks only)
Returns the unmasked system token for a server stack.
- Read
Get audit log for a stack
Returns the change history for a stack. Each entry records a mutation event with who made the change, when, and which fields were affected.
- Read
List dependencies of a stack
Returns the set of resources that depend on the specified stack.
- Write
Create a stack
Creates a new stack. For server stacks, retrieve the system token after creation via GET /v1/stacks/{id}/systemToken.
- Write
Share a stack with a user
Invites another integrator.io user to use this stack and emails them the invitation. Creates a pending share record — the stack becomes usable by the recipient only after they accept it (PUT /v1/sshares/{id}/accept).
- Destructive
Update a stack
Updates a stack. Omitting the config object clears optional fields like framework. To rotate a server stack's system token, use DELETE /v1/stacks/{id}/systemToken instead. Send the secrets as a GET returned them.
- Destructive
Delete a stack
Deletes a stack. Soft-deleted and retained in the recycle bin for 30 days.
- Destructive
Recycle stack system token (server stacks only)
Rotates (recycles) the server stack's system token. The old token is immediately invalidated. Retrieve the new token via GET /v1/stacks/{id}/systemToken.
State
- Read
List global state keys
Returns all global state key names. Does not return resource-scoped keys — use GET /v1/{resourceType}/{id}/state for those. Lists key names only, not values. Call GET /v1/state/{key} to retrieve a specific value.
- Read
Get a global state value
Returns the JSON value stored under the given global key. Returns the raw JSON value (object or array), not wrapped in an envelope.
- Read
List state keys for a resource
Returns the list of state key names stored under the specified resource. These keys are separate from global state. Returns 204 No Content when no keys exist for the resource. Only exports, imports, and integrations support resource-scoped state. Other resource types return 403.
- Read
Get a resource-scoped state value
Returns the JSON value stored under the given key for a specific resource. Only exports, imports, and integrations support resource-scoped state. Returns the raw JSON value (object or array), not wrapped in an envelope.
- Destructive
Delete all global state keys
Deletes all global state keys and their values. This is a destructive operation and cannot be undone. Prefer DELETE /v1/state/{key} to remove individual keys.
- Destructive
Create or update a global state value
Sets the value for a global state key. Creates the key if it does not exist; replaces the value if it does. The request body must be a non-empty JSON object or array. Bare JSON primitives (strings, numbers, booleans, null) and empty containers ({}, []) are rejected.
- Destructive
Delete a global state key
Deletes a specific global state key and its value. Returns 404 if the key does not exist.
- Destructive
Delete all state keys for a resource
Deletes all state keys and values stored under the specified resource. This is destructive and cannot be undone. Prefer DELETE /v1/{resourceType}/{resourceId}/state/{key} to remove individual keys.
- Destructive
Create or update a resource-scoped state value
Sets the value for a state key under a specific resource. Creates the key if it does not exist; replaces the value if it does. The request body must be a non-empty JSON object or array.
- Destructive
Delete a resource-scoped state key
Deletes a specific state key and its value from the resource. Returns 404 if the key does not exist.
Storage Query
- Read
Get a storage query job's status
Returns the job's lifecycle state and timestamps. Once status is completed the response also carries the result manifest — rowCount, pageCount, truncated, columns, and executionMs — which is everything needed to page through GET /v1/storage/query/{id}/results.
- Read
Get a page of storage query results
Returns one page of a completed job's rows. Pages run from 1 to the job's pageCount; omit page for the first one and keep requesting page + 1 while hasMore is true.
- Write
Submit a storage query
Validates one read-only SQL SELECT, resolves every storage path it references with the caller's own permissions, and queues it for execution.
Subscription & Entitlements
- Read
Get licenses (subscription)
Returns one account-level license (type is platform, integrator, or endpoint) plus zero or more connector, integrationApp, or integrationAppChild licenses, oldest first.
- Read
Get license entitlement usage
Returns entitlement usage for the environment the request is made in -- how many resources it is consuming vs. what is entitled. Pair with GET /v1/licenses for the entitlement limits; the license's pricing model decides what the flow count means.
- Read
Get historic label-printing usage
Returns account-wide EDI label-printing (BarTender) consumption bucketed into the trailing 12 ISO weeks (Monday–Sunday UTC), most-recent week first. Each week's total sums every flow and environment under the account.
- Read
Get historical monthly entitlement usage
Returns historical monthly usage for accounts whose pricing model meters flow runs (platform licenses), newest month first; the current month's row can carry null usage until the meter has processed. Useful for month-by-month trend analysis of usage vs. allocation.
- Read
Get usage records (legacy)
Returns historical usage records for the current account (legacy usage series). The response is an array of monthly records with a duration field (milliseconds).
Syncs
- Read
List syncs
Returns all syncs in the account, sorted by name. Filter to one integration with the integrationId query parameter (equivalent to GET /v1/integrations/{integrationId}/syncs).
- Read
Get a sync
Returns a single sync by ID.
- Read
List syncs in an integration
Returns the syncs that belong to one integration, sorted by name. Equivalent to GET /v1/syncs?integrationId={integrationId}.
- Read
List datasets for a sync
Returns the datasets configured on a sync — the tables/objects it replicates — sorted by name. Export-backed datasets whose export no longer uses the sync's source connection carry mismatchSyncConnection: true.
- Read
Get a dataset
Returns a single dataset of a sync by ID.
- Read
Get audit log for a sync
Returns the change history for a sync. Entries cover the sync itself and the related resources it depends on — its datasets (the tables being replicated) and the source and destination connections it uses — so a single response interleaves sync, dataset, and connection events.
- Read
List events for a sync
Returns the events recorded for a sync across all of its runs — schema drift the platform detected or applied, and data-catalog activity — newest first. Events are retained per the account's data retention period; a timelte older than the retention window returns an empty list.
- Read
Get per-sync usage for the current month
Returns the number of records each sync loaded during the current calendar month (UTC), for the current environment. Only syncs that ran this month appear.
- Read
Get monthly sync usage history
Returns account-wide sync usage by calendar month, newest first — the records loaded across all syncs and environments, alongside the account's Data Ingestion entitlement for each month. History reaches back at most 14 months.
- Read
Get sync usage by environment
Returns the records loaded by syncs during the current calendar month (UTC), broken down by environment — production plus every additional environment in the account. Environments with no runs this month report a volume of 0.
- Read
List supported sync source applications
Returns the catalog of applications that can be used as the source of a sync — the system a sync extracts records from. Use the returned id as the source application when building a sync, and category to group the options in a picker.
- Read
List supported sync destination applications
Returns the catalog of applications that can be used as the destination of a sync — the data warehouse a sync loads records into.
- Read
List datasets available on a connection
Returns the catalog of tables/objects a connection's application exposes for syncing, plus the connection's existing export resources that can back export-based datasets. Use the returned name values as externalId when creating datasets via PUT /v1/syncs/{syncId}/datasets.
- Read
Get column details for a dataset on a connection
Returns the full column/field catalog for one table/object on a connection, as read from the source application. Use it to build the dataElements selection before saving a dataset via PUT /v1/syncs/{syncId}/datasets — each element's name here is the name to reference there.
- Read
List a connection's datasets merged with a sync's configuration
Returns the connection's full dataset catalog with the sync's saved configuration merged in: catalog entries the sync already replicates carry their stored dataset fields (id, enable, ingestionMode, …) plus computed totalFieldCount and selectedFieldCount, while unsaved entries a…
- Read
Get column details for a dataset in a sync's context
Returns one table/object's full column catalog from the source, merged with the sync's saved dataset state — enablement, ingestionMode, exportProperties, drift policy, and per-column selections.
- Write
Create a sync
Creates a sync inside an integration. Only integrationId and source.connectionId are required — new syncs start as disabled drafts, so the destination, datasets, and schedule can be configured with later requests.
- Destructive
Update a sync
Replaces a sync's configuration. Send the complete desired state: omitted optional fields (schedule, timezone, destination details, the driftPolicy.element settings) are cleared, not preserved. integrationId cannot be sent — the integration is fixed at creation.
- Destructive
Delete a sync
Deletes a sync and tears down its replication resources, including its datasets. The sync must be disabled first — deleting an enabled sync fails with 400 syncdeletenotallowed. Syncs are not recoverable through the recycle bin.
- Destructive
Create or update datasets for a sync
Creates and updates a sync's datasets in one batch. Each array item either creates a dataset (identified by externalId) or updates one (identified by id); a single request can mix both.
Sync Jobs
- Read
List sync jobs for a sync
Returns parent sync jobs for the given sync, newest first. When a created-at filter is set, queued and running jobs are pinned to the first pages even if they fall outside the range; canceling jobs are not pinned.
- Read
Get a sync job
Returns a single sync job record. Sync jobs are read-only records created by the platform when a sync run is triggered. The record includes status, timing, record counts, and error counts.
- Read
Get a sync job and its table-level children
Returns the parent sync job with all of its per-table child jobs inlined under a tables array. Each table entry contains its own status, record counts, error counts, and timing.
- Read
List errors for a sync job
Returns errors produced during extraction or loading for the given parent sync job, scoped to individual tables. Use childJobId to filter to a single table. Without it, errors across all tables in the run are returned.
- Read
Get the latest sync job for each sync in an integration
Returns the most recent sync job for each sync resource belonging to the given integration. The response is a bare JSON array with one SyncJob entry per sync. Returns an empty response when no sync jobs exist for any sync in the integration.
- Write
Trigger a sync run
Queues an on-demand run of a sync and returns identifiers for the new sync job. The run is asynchronous: the response returns as soon as the job is queued. Use GET /v1/syncJobs/{syncJobId} or GET /v1/syncs/{syncId}/syncJobs to poll for terminal status.
- Destructive
Cancel all in-progress sync jobs
Cancels every queued or running sync job for the given sync, including the underlying flow jobs for each run. If every job is already terminal, the request is rejected.
- Destructive
Cancel a single sync job
Cancels a specific sync job by id, including its underlying flow jobs. Only queued or running jobs can be canceled. Terminal jobs cannot. A job whose cancellation is already in progress is not cancelled again.
Tags
- Read
List the account's tag catalog
Returns every tag defined in the account, each with its short tagId code and human-readable tag name. This is the catalog that backs the tag-picker on flow-step errors (PUT /v1/flows/{id}/{stepId}/tags).
- Read
Get a tag
Returns a single tag entry by its id.
- Write
Create a tag
Creates a new tag in the account's tag catalog. The server generates an immutable short tagId code automatically.
- Write
Patch a tag
Partially updates a tag using a JSON Patch document (RFC 6902). Only the replace operation is supported, and only on the following whitelisted path: | Path | Description | |------|-------------| | /tag | The human-readable tag name | All other paths are rejected with 422.
- Destructive
Update a tag
Updates the human-readable tag name for an existing tag entry. The short tagId code is immutable and cannot be changed.
- Destructive
Delete a tag
Permanently deletes a tag from the account's tag catalog.
Templates
- Read
List templates
Returns all templates owned by the authenticated Partner account. The response is a flat JSON array with no pagination.
- Read
Get a template
Returns a single template by ID.
- Read
Preview a template install from an uploaded zip
Previews the resources that would be created by installing a template from an uploaded zip file. The runKey query parameter ties this request to a previously uploaded zip (obtained from GET /v1/s3SignedURL).
- Write
Create a template
Creates a new integration template. Only name is required; all other fields are optional. Upload a zip via GET /v1/s3SignedURL before attempting to publish.
- Write
Install an integration from a template
Installs an integration from a published template. The caller provides a connectionMap that maps each template-defined connection ID to an actual connection ID in the caller's account. Every template connection must appear as a key in connectionMap.
- Write
Install a template from an uploaded zip
Installs a template from a previously uploaded zip file. The runKey in the request body ties this request to the zip upload (obtained from GET /v1/s3SignedURL). The zip carries connection definitions without credentials, and the installed integration receives new connection ids.
- Destructive
Update a template
Replaces the template's fields with the values in the request body. Omitted optional fields retain their current values. name is required on every PUT, even if unchanged.
- Destructive
Delete a template
Permanently deletes a template.
Tools
- Read
List tools
Returns all tools in the account. Filter by integrationId to scope results to a single integration.
- Read
Get a tool
Returns the complete configuration of a specific tool.
- Read
List connections a tool depends on
Returns the full Connection resources the tool references — both directly (via connectionId fields on its steps) and transitively through descendant resources (inner tools, lookups, imports, exports).
- Read
List resources a tool depends on, grouped by type
Returns the full dependency tree of a tool as three arrays: the imports, exports, and nested tools it references directly or transitively. Each entry is the complete resource document, so the caller doesn't need to fan out individual GETs.
- Read
Preview cloning a tool
Returns a preview of the resources that would be created by cloning this tool. No resources are created. Call this before POST /v1/tools/{id}/clone to inspect what the clone would create.
- Read
List dependencies of a tool
Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries. Returns {} for both zero-dependency and nonexistent IDs.
- Read
Get a downloadable template for a tool
Packages the tool as an installable template and returns a signed S3 URL where the template .zip can be downloaded. The URL is pre-signed and short-lived (approximately 15 minutes), so fetch the file promptly; call the endpoint again for a fresh URL.
- Read
List Tool invocation run history
Returns the run history for a Tool — one entry per invocation that ran with enterprise logging enabled (x-log-mode on POST /v1/tools/{id}/invoke, or the log level forwarded by the calling Agent, MCP server, or Guardrail). Invocations that ran without logging never appear here.
- Read
Get trace metadata for a Tool invocation
Returns the invocation header plus one step record per stage the run passed through: the Tool's input bubble ( input), each export or import step, and the output bubble ( output). A run that failed before any step executed returns an empty steps array.
- Read
List child records under a Tool trace step
Returns the child records a step produced from one parent record — the rows a lookup step returned, or the records a one-to-many expansion generated. parentRecordId is the recordId of the step entry on the trace-metadata response.
- Read
Query decoded log data for a Tool trace step
Returns the payload a step processed during the invocation — what went in and what came out — selected by expOrImpId, stage, groupId, and recordId from the trace-metadata response.
- Read
Get a signed URL for a stored Tool log payload
Returns a short-lived signed URL to download a stored log payload that the log-data endpoint returned as an external reference (externalReference[].source.s3Key).
- Read
List captured request logs for a Tool
Lists the request/response envelopes the platform has stored for this Tool as a whole — the Tool-level counterpart of GET /v1/apis/{id}/logs. Entries are file-backed with server-controlled retention; an empty requests[] means nothing is currently stored.
- Read
Get one captured request log by key
Returns the full stored request/response envelope for one captured Tool request, looked up by a key from GET /v1/tools/{id}/logs. The key must match exactly; a key that has expired from retention or was never stored returns 404 filenotfound.
- Read
Get a tool test-run step result
Returns the stage-by-stage result of a single step from a prior tool test run. Each entry in stages[] describes one stage (e.g. request, parse, router, input) with its input, output, and any errors. The runId is the flowJob.id returned by POST /v1/tools/{id}/test/run.
- Read
Get request/response logs for a tool test-run step
Returns the outbound HTTP request/response log pairs captured during a specific step of a tool test run.
- Read
List captured debug requests for a tool step
Lists the debug request records captured for a specific step of a tool. These are the raw request/response payloads the step processed, retained for troubleshooting while debug capture is active for the step — a future debugUntil on the step's export or import document, or input.
- Read
Get a captured debug request for a tool step
Returns the full detail of a single captured debug request for a tool step, identified by its key. Obtain the key from GET /v1/tools/{id}/{stepId}/requests.
- Write
Create a tool
Creates a new tool within an integration. name and integrationId are required. Routers use firstmatchingbranch strategy only, and each branch's nextRouterId must point to another router's id or "outputRouter" to exit the tool.
- Write
Patch a tool
Partially updates a tool using a JSON Patch document (RFC 6902).
- Write
Clone a tool
Creates a copy of a tool in the target integration, together with the export and import steps it references, and returns a manifest of the resources the clone created. The clone records its lineage in sourceId, which places it in the source tool's clone family.
- Write
Invoke a Tool synchronously
Executes a Tool synchronously and returns the mapped output (or errors). Optional x-log-mode enables enterprise invocation logging.
- Write
Run a tool in test mode
Synchronously executes a tool in test mode and returns the run metadata together with the resulting flow job and its child jobs. Use this to validate a tool's routing and step configuration before referencing it from a flow, API, agent, or MCP server.
- Destructive
Update a tool
Replaces the tool configuration — GET the tool first, modify the fields you need, then PUT the full object back. Omitting description, routers, or aiDescription removes them.
- Destructive
Delete a tool
Deletes a tool. Soft-deleted and retained in the recycle bin for 30 days.
- Destructive
Replace a connection across a tool
Repoints every export and import step in the tool's routers that uses connectionId to newConnectionId, saving each step resource in place.
- Destructive
Delete Tool invocation logs in a date range
Queues asynchronous deletion of the stored invocation logs for the Tool within [timegte, timelte]. Returns 202 Accepted immediately; the entries disappear from GET /v1/tools/{id}/invocations once the background cleanup runs. Requires log-deletion access. Sandbox Tools return 403.
- Destructive
Delete captured request logs for a Tool
Deletes stored request/response envelopes by the key values listed by GET /v1/tools/{id}/logs, between 1 and 1000 per call. The response separates the keys that were removed from the keys that failed, with the storage failure reason.
- Destructive
Delete captured debug requests for a tool step
Deletes captured debug request records for a specific step of a tool, by their key values from GET /v1/tools/{id}/{stepId}/requests. Between 1 and 1000 keys can be deleted per call; the deletion is synchronous and scoped to this step only.
Topics
- Read
List topics
Returns the account's topics sorted by name ascending (ties by most recently modified first). Topics in the recycle bin are not included. include and exclude projections are not supported on this resource.
- Read
Get a topic
Returns a topic's configuration. Read its messages with GET /v1/topics/{id}/messages. A topic in the recycle bin is reported as not found; restore it first.
- Read
List retained messages
Reads the messages currently retained on a topic, oldest first, without affecting any listener's read position — use it to inspect what producers are publishing or to confirm a purge. Pages are cursor-based: follow nextPageURL until it is absent.
- Read
Get a listener's read position
Reports how far a topic export (listener) has read on this topic — where its next run resumes. Use it to check whether a listener is keeping up, or whether it has a read position at all: it has none while it has not subscribed, or while its topic has never received a message.
- Read
Get audit log for a topic
Returns the change history for a topic, newest first: who changed what and when, including message purges, recycle-bin deletes and restores. Works for a topic in the recycle bin; once the topic is purged, query GET /v1/audit?resourceType=topic&resourceId={id} instead.
- Read
List dependencies of a topic
Returns the resources that reference the topic: exports and imports bound to it through topic.topicId, flows that contain those steps, and integrations that list it in registeredTopicIds.
- Write
Create a topic
Creates a topic and counts it against the license's topics.topicsAllowed quota. The stream itself is provisioned lazily on the first publish, so a new topic reports no messages until something is published to it.
- Write
Patch a topic
Applies a JSON Patch document (RFC 6902) to the topic. Only /name and /description are patchable; every other path — including /retentionMs and /externalId — is rejected, so use PUT to change those. Unlike PUT, fields not named in the patch are left untouched.
- Write
Publish messages to a topic
Appends messages to the topic in the order given, so every subscribed topic export receives them on its next read. The first publish to a new topic provisions its stream, which can take a few seconds longer than later calls.
- Destructive
Update a topic
Replaces the topic's writable fields with the request body. Fields left out are cleared, not kept: description and externalId are removed and retentionMs reverts to seven days — send the full document, or use PATCH to change name or description alone.
- Destructive
Delete a topic
Moves the topic to the recycle bin, where it is kept for 30 days before being purged, and removes it from registeredTopicIds on every integration that had it registered; restoring it does not re-register it.
- Destructive
Purge retained messages
Removes every retained message from the topic while keeping the topic, its retention setting, and its subscriptions; the purge cannot be undone.
Trading Partner Connectors
- Read
List trading partner connectors
Returns all trading partner connectors visible to the caller. Published connectors are visible to everyone; unpublished connectors are visible only to their owner.
- Read
Get a trading partner connector
Returns the complete configuration of a trading partner connector, including all supportedBy sections. Unpublished connectors are only visible to their owner. The list endpoint returns a summary that omits published and supportedBy.
- Write
Create a trading partner connector
Creates a new trading partner connector. Only name is required. Setting published: true requires the allowedToPublishTPConnectors permission; without it the field is silently ignored.
- Destructive
Update a trading partner connector
Replaces an existing trading partner connector (a full replace). Create connectors with POST /v1/tpconnectors. When published is set to true, the supportedBy sections are validated for required fields.
- Destructive
Delete a trading partner connector
Deletes a trading partner connector. The recycle bin doesn't take trading partner connectors, so there is no route to restore a deleted one.
Users
- Read
List users
Returns all users with access to the account. The account owner is not included — only invited users appear. Without userType the list holds workspace records only; end-user records (MCP-only consumers managed through the End Users API) are included only when asked for.
- Read
Get a user
Retrieve a single user's access record by its id. Returns the bare record: the user is identified by sharedWithUserId rather than the expanded sharedWithUser the list returns, and isProductionAdmin is not computed.
- Write
Invite users to the account
Invite one or more users by email. Each entry in the response array corresponds to the email at the same index — check statusCode per entry for partial failures.
- Destructive
Update a user
Replaces a workspace user's access settings. The body must grant access through accessLevel or a non-empty integrationAccessLevel, and accessLevel, integrationAccessLevel and accountMFARequired are cleared when omitted — send every value to keep.
- Destructive
Delete a user
Remove a user from the current account. This is irreversible — for a reversible alternative, use PUT /v1/ashares/{id}/disable. Works on both accepted and pending invites.
- Destructive
Toggle a user's account access (disable or re-enable)
Toggles the disabled flag on a user's access record. Call again to re-enable — there is no separate /enable path, and this is the only way to change disabled (the update operation does not apply it).
- Destructive
Reinvite a user who dismissed their invite
Re-sends the invitation to a user who previously dismissed it. Only works on users with dismissed: true in the user record. After reinviting, the user returns to a pending state awaiting acceptance.
- Destructive
Accept an account invitation
Accepts an invitation to another user's account on behalf of the caller. The id is a share record addressed to the caller — take it from GET /v1/shared/ashares, not from GET /v1/ashares.
- Destructive
Dismiss an account invitation
Declines an invitation to another user's account on behalf of the caller. The id is a share record addressed to the caller — take it from GET /v1/shared/ashares.
No operations match.
See How connections work for access and permissions, or browse all integrations.