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_TOKENCustomer Impersonation (Sender API)
Use the X-Customer header when acting on behalf of a specific customer.
X-Customer: customer@example.com
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
Customers
Customer Directory
List and search customers via the public API.
GET
[Customer] List customers.
https://api.wetransform.com/customers
Authenticated user or application
GET
[Customer] Read a customer.
https://api.wetransform.com/customer/{customerId}
roles.customer
PUT
[Customer] Update a customer.
https://api.wetransform.com/customer/{customerId}
roles.customer
POST
[Customer] Create a customer.
https://api.wetransform.com/customer
Authenticated user or application
DELETE
[Customer] Delete a customer.
https://api.wetransform.com/customer/{customerId}
roles.customer
Data Transformation
Transformation CRUD
List, create, duplicate, delete, and manage transformations.
GET
[Transformations] List transformations.
https://api.wetransform.com/transformations
Authenticated customer
GET
[Transformations] List deleted transformations.
https://api.wetransform.com/transformations/trash
Authenticated customer
GET
[Transformations] Read a transformation.
https://api.wetransform.com/transformation/{transformationId}
Authenticated customer
Can use the selected target format.
Can use the selected source.
Source Data
Read source data rows and metadata via the public API.
GET
[Source feeds] List source configurations.
https://api.wetransform.com/sender/sources
Authenticated customer
POST
[Source feeds] Create a source configuration.
https://api.wetransform.com/sender/source
Authenticated customer
GET
[Source feeds] Read a source configuration.
https://api.wetransform.com/sender/source/{sourceId}
Authenticated customer
Can use the selected source.
PUT
[Source feeds] Update a source configuration.
https://api.wetransform.com/sender/source/{sourceId}
Authenticated customer
Can use the selected source.
DELETE
[Source feeds] Delete a source configuration and its schedules.
https://api.wetransform.com/sender/source/{sourceId}
Authenticated customer
Can use the selected source.
DELETE
[Source feeds] Deactivate schedules linked to a source.
https://api.wetransform.com/sender/source/{sourceId}/schedules
Authenticated customer
Can use the selected source.
POST
[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.
GET
[Submission] List submissions.
https://api.wetransform.com/sender/submissions
Authenticated customer
GET
[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.
GET
[Submission] Read a submission by its download URL.
https://api.wetransform.com/sender/submission
Authenticated customer
GET
[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.
DELETE
[Transformations] Delete a transformation.
https://api.wetransform.com/transformation/{transformationId}
Authenticated customer
Can use the selected target format.
Can use the selected source.
PUT
[Transformations] Undelete a transformation.
https://api.wetransform.com/transformation/{transformationId}
Authenticated customer
Can use the selected target format.
Can use the selected source.
DELETE
[Transformations] Delete all transformations tied to a source.
https://api.wetransform.com/transformation/delete-by-source/{sourceId}
Authenticated customer
Can use the selected source.
PUT
[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.
GET
[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.
PUT
[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.
Automation
Manage automated transformation workflows.
POST
[Transformations] Run a transformation.
https://api.wetransform.com/transformation/automation/{transformationId}
Authenticated customer
Can use the selected target format.
Can use the selected source.
GET
[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.
GET
[Power functions] Fetch data from the transformation dataset.
https://api.wetransform.com/power-functions/{callId}/{callNumber}/fetch
Can call the given power function.
POST
PUT
[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.
POST
[Constraint] Create a constraint.
https://api.wetransform.com/constraint
Authenticated user or application
GET
[Constraint] Read a constraint.
https://api.wetransform.com/constraint/{constraintId}
Can manage the selected target format.
PUT
[Constraint] Update a constraint.
https://api.wetransform.com/constraint/{constraintId}
Can manage the selected target format.
DELETE
[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.
POST
[Column] Create a column.
https://api.wetransform.com/template/{templateHandle}/column
Can manage the selected target format.
GET
[Column] List columns.
https://api.wetransform.com/template/{templateHandle}/columns
Resource owned by the organisation
GET
[Column] Read a column.
https://api.wetransform.com/template/{templateHandle}/column/{columnId}
Resource owned by the organisation
PUT
[Column] Update a column.
https://api.wetransform.com/template/{templateHandle}/column/{columnId}
Can manage the selected target format.
DELETE
[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.
GET
[Template] List templates.
https://api.wetransform.com/templates
Authenticated user or application
GET
[Template] Read a template.
https://api.wetransform.com/template/{templateHandle}
Resource owned by the organisation
POST
[Template] Create a template.
https://api.wetransform.com/template
Can manage all target formats
PUT
[Template] Update a template.
https://api.wetransform.com/template/{templateHandle}
Can manage the selected target format.
DELETE
[Template] Delete a template.
https://api.wetransform.com/template/{templateHandle}
Can manage all target formats
GET
[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.
POST
[Bulk Import] Import columns from a CSV file.
https://api.wetransform.com/bulk-import/columns/{templateHandle}/{method}
Can manage the selected target format.
POST
[Bulk Import] Import value lists from a CSV file.
https://api.wetransform.com/bulk-import/values/{templateHandle}/{method}
Can manage the selected target format.
GET
[Bulk Import] Get status of a bulk import.
https://api.wetransform.com/bulk-import/{importId}/status
Resource owned by the organisation
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.
GET
[Demo Receiver] Using parameters in the query string.
https://api.wetransform.com/en/hello
Authenticated user or application
GET
[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
POST
[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.
GET
[Demo Sender] Using parameters in the query string.
https://api.wetransform.com/en/send/{subdomain}/hello
Authenticated customer
GET
[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
POST
[Demo Sender] Uploading files.
https://api.wetransform.com/en/send/{subdomain}/hello/file-upload
Authenticated customer