GEThttps://api.transmutify.io/v1/schemas

List target schemas defined for the caller's organization

Each schema describes the desired output structure for a transformation: a map of target field names to their `description`, `data_type`, and `is_required` flag. Use a schema's returned `id` as `schema_id` when initializing a transformation run.

Requires a bearer token. Learn more about authentication

Responses

dataobject[] required
idstring required

Stable schema identifier. Pass this as `schema_id` when creating a transformation run.

namestring required

User-defined name for this schema.

fieldsobject required

Map of target field definitions keyed by field name. Each entry contains `description`, `data_type`, `is_required`, and optional `label`.

created_atstring | null required

ISO-8601 UTC timestamp the schema was created.

updated_atstring | null required

ISO-8601 UTC timestamp the schema was last updated.

linksobject required
firststring | null required
laststring | null required
prevstring | null required
nextstring | null required
metaobject required
current_pageinteger required
frominteger | null required
last_pageinteger required
linksobject[] required

Generated paginator links.

urlstring | null required
labelstring required
activeboolean required
pathstring | null required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

tointeger | null required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

cURL
curl -X GET 'https://api.transmutify.io/v1/schemas' \
  -H 'Authorization: Bearer <api-key>'
Response · 200
{
  "data": [
    {
      "id": "019dc458-710e-73a0-9b5a-bb7d6f7ddc42",
      "name": "Employee import",
      "fields": {
        "employee_id": {
          "label": "Employee ID",
          "description": "Stable employee identifier from the source HR system.",
          "data_type": "string",
          "is_required": true,
          "transformations": {
            "trim_whitespace": {
              "enabled": true
            },
            "uppercase": {
              "enabled": true
            }
          }
        },
        "work_email": {
          "label": "Work Email",
          "description": "Employee work email address.",
          "data_type": "email",
          "is_required": true,
          "transformations": {
            "trim_whitespace": {
              "enabled": true
            },
            "lowercase": {
              "enabled": true
            }
          }
        },
        "start_date": {
          "label": "Start Date",
          "description": "First day of employment.",
          "data_type": "date",
          "format": "Y-m-d",
          "is_required": false,
          "transformations": {
            "date_format": {
              "enabled": true,
              "from": "m/d/Y",
              "to": "Y-m-d"
            }
          }
        }
      },
      "created_at": "2026-01-10T09:10:00Z",
      "updated_at": "2026-01-10T09:10:00Z"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": false
      }
    ],
    "path": "string",
    "per_page": 0,
    "to": 1,
    "total": 0
  }
}