[Transformations] Read a transformation.
This endpoint will give details about a particular transformation, such as its import date, source file name, download_url and more.
https://api.wetransform.com/transformation/{transformationId}
| Parameter | Description | Pattern |
|---|---|---|
{transformationId} |
The transformation UUID to read |
[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12} |
success
boolean
Always true on successful responses.
true
payload
object
Payload of the requested resource.
payload.source_id
string
The source identifier.
"8c2a786d-6d70-4fc0-99f3-53186999177b"
payload.source_name
*
string
The source name.
"my-employees.csv"
payload.source_file_url
*
string
The source file URL, if it still exists
payload.imported_at
datetime
The date and time the source was imported.
payload.template_name
string
The template name.
"Employee Leaves (RE)"
payload.template_picture_url
*
string
The template picture URL.
"https:\/\/api.wetransform.com\/icon.png"
payload.transformation_id
string
The transformation identifier.
"9784c123-d916-4736-bfd7-ce7db6ce4ab7"
payload.has_schedule
boolean
Whether the transformation has an enabled schedule.
true
payload.column_names
array
The columns' names.
payload.custom_field_names
array
The custom fields' names.
payload.deleted_at
*
datetime
The date and time the transformation was deleted, if applicable.
payload.download_url
*
string
The download URL of the transformed file.
"https:\/\/api.wetransform.com\/file\/w12xv1eypby1wpsvepzl7py4pxac9iw0.csv"
payload.template_handle
string
The template handle.
"furniture"
product
*
object
A product needed.
Not null if user requires to buy a specific product (permission or limitation) in order to access a feature.
product.requirement
*
string
Whether the user requested a features s/he doesn't have access to,
or the user needs greater limits.
Possible values: permission, limitation
"permission"
product.permission
*
object
The required permission.
You will need to know which permission is needed in order to fill up search filters in the shop.
product.permission.description
*
string
A human-understandable name for the permission.
product.permission.name
string
A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).
Possible values depend on the context, check the domain's metadata endpoint.
"X_SOURCE_FORMAT_XML"
product.limitation_type
*
string
The limitation that needs to be increased (ex: number of columns).
product.limitation_needed_value
*
integer
The needed resource quantity (if receiver uses 9 columns in a template, this value is 9).
product.limitation_current_value
*
integer
The current value of the limitation (if receiver is allowed to use 10 columns, this value is 10).
product.limitation_object
*
object
The limitation type in a readable format, for example, "lines per file".
product.is_cta
*
boolean
Whether a Call To Action should be displayed.
It may not be displayed if:
- the limitation is on the membership role
- the limitation is on the customer role
- the user is a sender
template_handle
*
string
Handle of the template currently in context, if any.
Many endpoints (and frontend components) require a template_handle. It is
exposed here so consumers — most notably the AI agent — can reuse it
instead of having to ask the user for it again.
"new-hires"
source_id
*
string
UUID of the source currently in context, if any.
Many endpoints (and frontend components) require a source_id (the source
UUID, not its database id). It is exposed here so consumers — most notably
the AI agent — can reuse it instead of having to ask the user for it again.
"9e7060d4-9314-4783-883a-8702471ccd39"
debug
array
Debug information.
Contains logs about business logic explaining state of the response payload.
Provided in development & admin modes only.
* are nullable.
{
"success": true,
"payload": {
"source_id": "8c2a786d-6d70-4fc0-99f3-53186999177b",
"source_name": "my-employees.csv",
"source_file_url": null,
"imported_at": "2026-07-05T18:52:58+00:00",
"template_name": "Employee Leaves (RE)",
"template_picture_url": "https:\/\/api.wetransform.com\/icon.png",
"transformation_id": "9784c123-d916-4736-bfd7-ce7db6ce4ab7",
"has_schedule": true,
"column_names": [
"column1",
"column2"
],
"custom_field_names": [
"custom1",
"custom2"
],
"deleted_at": null,
"download_url": "https:\/\/api.wetransform.com\/file\/w12xv1eypby1wpsvepzl7py4pxac9iw0.csv",
"template_handle": "furniture"
},
"product": {
"requirement": "permission",
"permission": {
"name": "X_SOURCE_FORMAT_XML",
"description": "Can import XML files"
},
"limitation_type": null,
"limitation_needed_value": null,
"limitation_current_value": null,
"limitation_object": null,
"is_cta": false
},
"template_handle": "new-hires",
"source_id": "9e7060d4-9314-4783-883a-8702471ccd39",
"debug": []
}User is well authenticated, but not authorized to access the resource.
It can happen if user is trying to use a feature that s/he didn't pay for, access someone else's resource, etc.
These issues are normally fixed by the frontend, which should render features and resources user has access to.
success
boolean
Always false on error responses.
false
payload
object
Context about the error, if any.
product
*
object
A product needed.
Not null if user requires to buy a specific product (permission or limitation) in order to access a feature.
product.requirement
*
string
Whether the user requested a features s/he doesn't have access to,
or the user needs greater limits.
Possible values: permission, limitation
"permission"
product.permission
*
object
The required permission.
You will need to know which permission is needed in order to fill up search filters in the shop.
product.permission.description
*
string
A human-understandable name for the permission.
product.permission.name
string
A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).
Possible values depend on the context, check the domain's metadata endpoint.
"X_SOURCE_FORMAT_XML"
product.limitation_type
*
string
The limitation that needs to be increased (ex: number of columns).
product.limitation_needed_value
*
integer
The needed resource quantity (if receiver uses 9 columns in a template, this value is 9).
product.limitation_current_value
*
integer
The current value of the limitation (if receiver is allowed to use 10 columns, this value is 10).
product.limitation_object
*
object
The limitation type in a readable format, for example, "lines per file".
product.is_cta
*
boolean
Whether a Call To Action should be displayed.
It may not be displayed if:
- the limitation is on the membership role
- the limitation is on the customer role
- the user is a sender
template_handle
*
string
Handle of the template currently in context, if any.
Many endpoints (and frontend components) require a template_handle. It is
exposed here so consumers — most notably the AI agent — can reuse it
instead of having to ask the user for it again.
"new-hires"
source_id
*
string
UUID of the source currently in context, if any.
Many endpoints (and frontend components) require a source_id (the source
UUID, not its database id). It is exposed here so consumers — most notably
the AI agent — can reuse it instead of having to ask the user for it again.
"9e7060d4-9314-4783-883a-8702471ccd39"
debug
array
Debug information.
Contains logs about business logic explaining state of the response payload.
Provided in development & admin modes only.
* are nullable.
{
"success": false,
"payload": [],
"product": {
"requirement": "permission",
"permission": {
"name": "X_SOURCE_FORMAT_XML",
"description": "Can import XML files"
},
"limitation_type": null,
"limitation_needed_value": null,
"limitation_current_value": null,
"limitation_object": null,
"is_cta": false
},
"template_handle": "new-hires",
"source_id": "9e7060d4-9314-4783-883a-8702471ccd39",
"debug": []
}