---
title: "Preview a transformation against an existing entity"
method: POST
path: "/organizations/{orgId}/integrationtransformations/preview"
tags: ["IntegrationTransformations"]
---

# Preview a transformation against an existing entity

`POST /organizations/{orgId}/integrationtransformations/preview`

## Request

- Base URL: `https://api.m3ter.com`
- URL: `https://api.m3ter.com/organizations/{orgId}/integrationtransformations/preview`
- Auth: OAuth 2
  - Authorization code: `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize`, token URL `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token`
  - Client credentials, token URL `/oauth/token`
- TypeScript: <https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/integrationtransformations/preview/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new transformation

## Path parameters

- `orgId` string, required

## Request body

- IntegrationTransformationPreviewRequest
  - `entity` string, required
  - `entityId` string, required
  - `system` string, required
  - `entitySchema` string, required
  - `transformations` AbstractLookupRequest[], required
    - `destinationField` string, required
    - `type` 'CALCULATION' | 'STATIC' | 'LOOKUP', required
  - `rawData` object, required

## Response `200`

Return the IntegrationTransformationPreviewResponse

- IntegrationTransformationPreviewResponse: Response containing a preview of a transformation
  - `transformedObject` object
  - `validationErrors` TypeValidationErrorResponse[]
    - `message` string, required
    - `field` string, required
    - `severity` 'ERROR' | 'WARNING' | 'INFO', required

## Other responses

- `4XX`: Error message
- `5XX`: Error message

## Changes

- **2026-10-16** `85c514abc692`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/m3ter-com/apis/m3ter-api/changes/organizations/:orgId/integrationtransformations/preview/post.md)

---

[API](https://skmtc.dev/m3ter-com/apis/m3ter-api.md) - [All operations](https://skmtc.dev/m3ter-com/apis/m3ter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/m3ter-com/apis/m3ter-api/revisions/85c514abc692?raw)
