API documentation

API Overview

The WeTransform API allows you to programmatically manage file transformations, customer accounts, and integration workflows. Built on RESTful principles, it returns JSON-encoded responses.

Receiver API

Manage transformation templates, customer profiles, and organisational metadata.

Sender API

Upload files, monitor transformation jobs, and manage results via /send/{subdomain}.

Authentication

WeTransform uses Bearer tokens. Generate and manage API tokens in your account settings.

Authorization: Bearer YOUR_TOKEN

Customer Impersonation (Sender API)

Use the X-Customer header when acting on behalf of a specific customer. The header accepts any of the following identifiers — you do not need to store or map WeTransform UUIDs on your side:

Identifier	Example
External ID — your own identifier for the customer, set via the `external_id` field when creating or updating the customer	`X-Customer: your-crm-id-42`
Email address of the customer	`X-Customer: customer@example.com`
WeTransform customer UUID	`X-Customer: 1ed1f5b2-…`

The recommended integration pattern is to pass your own customer identifier as external_id when creating customers, then reuse that same identifier in the X-Customer header — no identifier mapping is required.

To test endpoints, please login.

Localization

WeTransform supports multiple languages. The path prefix determines the response language.

Locale	Path prefix
`fr`	`/fr/…`
`en`	`/en/…`

Endpoints

Getting Started

Demo and test endpoints to verify your API integration is working.

Hello World (Receiver) Test GET, POST, PUT, DELETE requests with receiver authentication.

[Demo Receiver] Using parameters in the query string.

https://api.wetransform.com/en/hello

Authenticated user or application

[Demo Receiver] Using URL {attributes}.

https://api.wetransform.com/en/hello/{name}

Authenticated user or application

POST PUT DELETE

[Demo Receiver] Using a JSON body.

https://api.wetransform.com/en/hello

Authenticated user or application

[Demo Receiver] Uploading files.

https://api.wetransform.com/en/hello/file-upload

Authenticated user or application

Hello World (Sender) Test GET, POST, PUT, DELETE requests with sender (customer) authentication.

[Demo Sender] Using parameters in the query string.

https://api.wetransform.com/en/send/{subdomain}/hello

Authenticated customer

[Demo Sender] Using URL {attributes}.

https://api.wetransform.com/en/send/{subdomain}/hello/{name}

Authenticated customer

POST PUT DELETE

[Demo Sender] Using a JSON body.

https://api.wetransform.com/en/send/{subdomain}/hello

Authenticated customer

[Demo Sender] Uploading files.

https://api.wetransform.com/en/send/{subdomain}/hello/file-upload

Authenticated customer

Customers

Customer Directory List and search customers via the public API.

[Customer] List customers.

https://api.wetransform.com/customers

Authenticated user or application

[Customer] Read a customer.

https://api.wetransform.com/customer/{customerId}

[Customer] Update a customer.

https://api.wetransform.com/customer/{customerId}

[Customer] Create a customer.

https://api.wetransform.com/customer

Authenticated user or application

[Customer] Delete a customer.

https://api.wetransform.com/customer/{customerId}

Data Transformation

Transformation CRUD List, create, duplicate, delete, and manage transformations.

[Transformations] List transformations.

https://api.wetransform.com/transformations

Authenticated customer

[Transformations] List deleted transformations.

https://api.wetransform.com/transformations/trash

Authenticated customer

[Transformations] Read a transformation.

https://api.wetransform.com/transformation/{transformationId}

Authenticated customer Can use the selected target format. Can use the selected source. roles.transformation

Source Data Read source data rows and metadata via the public API.

[Source feeds] List source configurations.

https://api.wetransform.com/sender/sources

Authenticated customer

[Source feeds] Create a source configuration.

https://api.wetransform.com/sender/source

Authenticated customer

[Source feeds] Read a source configuration.

https://api.wetransform.com/sender/source/{sourceId}

Authenticated customer Can use the selected source.

[Source feeds] Update a source configuration.

https://api.wetransform.com/sender/source/{sourceId}

Authenticated customer Can use the selected source.

[Source feeds] Delete a source configuration and its schedules.

https://api.wetransform.com/sender/source/{sourceId}

Authenticated customer Can use the selected source.

[Source feeds] Deactivate schedules linked to a source.

https://api.wetransform.com/sender/source/{sourceId}/schedules

Authenticated customer Can use the selected source.

[Source feeds] Activate schedules linked to a source.

https://api.wetransform.com/sender/source/{sourceId}/schedules

Authenticated customer Can use the selected source.

Submission Submit the transformed file, check status, and view submission history.

[Submission] List submissions.

https://api.wetransform.com/sender/submissions

Authenticated customer

[Submission] List submissions for a transformation.

https://api.wetransform.com/sender/submissions/transformation/{transformationId}

Authenticated customer Can use the selected target format. Can use the selected source.

[Submission] Read a submission by its download URL.

https://api.wetransform.com/sender/submission

Authenticated customer

[Submission] Read a submission.

https://api.wetransform.com/sender/submission/{submissionId}

Authenticated customer Resource owned by the organisation

Transformation Status Check transformation status and manage lifecycle via the public API.

[Transformations] Delete a transformation.

https://api.wetransform.com/transformation/{transformationId}

Authenticated customer Can use the selected target format. Can use the selected source. roles.transformation

[Transformations] Undelete a transformation.

https://api.wetransform.com/transformation/{transformationId}

Authenticated customer Can use the selected target format. Can use the selected source. roles.transformation

[Transformations] Delete all transformations tied to a source.

https://api.wetransform.com/transformation/delete-by-source/{sourceId}

Authenticated customer Can use the selected source.

[Transformations] Undelete all transformations tied to a source.

https://api.wetransform.com/transformation/undelete-by-source/{sourceId}

Authenticated customer Can use the selected source.

Transformation Data Read and update transformation data rows via the public API.

[Transformations] Get data from a transformation.

https://api.wetransform.com/transformation/{transformationId}/data

Authenticated customer Can use the selected target format. Can use the selected source. roles.transformation

[Transformations] Update data from a transformation.

https://api.wetransform.com/transformation/{transformationId}/data

Authenticated customer Can use the selected target format. Can use the selected source. roles.transformation

Automation Manage automated transformation workflows.

[Transformations] Transform an uploaded file.

https://api.wetransform.com/transformation/automation/{transformationId}/upload

Authenticated customer Can use the selected target format. Can use the selected source. roles.transformation

[Transformations] Run a transformation.

https://api.wetransform.com/transformation/automation/{transformationId}

Authenticated customer Can use the selected target format. Can use the selected source. roles.transformation

[Transformations] Get the status of a transformation.

https://api.wetransform.com/transformation/automation/{automationId}

Authenticated customer Resource owned by the customer

Integrations

Power Functions (Execution) Fetch data, populate results, and abort ongoing power function calls.

[Power functions] Fetch data from the transformation dataset.

https://api.wetransform.com/power-functions/{callId}/{callNumber}/fetch

Can call the given power function.

[Power functions] Populate the function's result to the transformation dataset.

https://api.wetransform.com/power-functions/{callId}/{callNumber}/populate

Can call the given power function.

GET POST PUT PATCH DELETE

[Power functions] Abort an ongoing Power function call.

https://api.wetransform.com/power-functions/{callId}/{callNumber}/abort

Can call the given power function.

Templates

Constraints Manage column validation constraints.

[Constraint] Create a constraint.

https://api.wetransform.com/constraint

Authenticated user or application

[Constraint] Read a constraint.

https://api.wetransform.com/constraint/{constraintId}

Can manage the selected target format.

[Constraint] Update a constraint.

https://api.wetransform.com/constraint/{constraintId}

Can manage the selected target format.

[Constraint] Delete a constraint.

https://api.wetransform.com/constraint/{constraintId}

Can manage the selected target format.

Public Columns Create, read, update, and delete template columns via the public API.

[Column] Create a column.

https://api.wetransform.com/template/{templateHandle}/column

Can manage the selected target format.

[Column] List columns.

https://api.wetransform.com/template/{templateHandle}/columns

Resource owned by the organisation

[Column] Read a column.

https://api.wetransform.com/template/{templateHandle}/column/{columnId}

Resource owned by the organisation

[Column] Update a column.

https://api.wetransform.com/template/{templateHandle}/column/{columnId}

Can manage the selected target format.

[Column] Delete a column.

https://api.wetransform.com/template/{templateHandle}/column/{columnId}

Can manage the selected target format.

Public Templates Create, read, update, delete, and list templates via the public API.

[Template] List templates.

https://api.wetransform.com/templates

Authenticated user or application

[Template] Read a template.

https://api.wetransform.com/template/{templateHandle}

Resource owned by the organisation

[Template] Create a template.

https://api.wetransform.com/template

Can manage all target formats

[Template] Update a template.

https://api.wetransform.com/template/{templateHandle}

Can manage the selected target format.

[Template] Delete a template.

https://api.wetransform.com/template/{templateHandle}

Can manage all target formats

[Template] List template's customers.

https://api.wetransform.com/template/{templateHandle}/customers

Resource owned by the organisation

Public Bulk Import Bulk import columns and value lists by uploading a CSV file via the public API.

[Bulk Import] Import value lists from a CSV file URL.

https://api.wetransform.com/bulk-import/values/{templateHandle}/{method}/url

Can manage the selected target format.

[Bulk Import] Import columns from a CSV file URL.

https://api.wetransform.com/bulk-import/columns/{templateHandle}/{method}/url

Can manage the selected target format.

[Bulk Import] Get status of a bulk import.

https://api.wetransform.com/bulk-import/{importId}/status

Resource owned by the organisation

[Bulk Import] Import columns from a CSV file.

https://api.wetransform.com/bulk-import/columns/{templateHandle}/{method}

Can manage the selected target format.

[Bulk Import] Import value lists from a CSV file.

https://api.wetransform.com/bulk-import/values/{templateHandle}/{method}

Can manage the selected target format.

Interactive Console

Please login in order to access the console.

Code assistant

live

Any language

Every endpoint.
In your language.

Auth, templates, transformations, webhooks, power functions — describe the call and name any language. You'll get production code that talks to the real API.

real endpoints real auth any language