---
title: "Preview Custom Field"
method: POST
path: "/api/v1/custom-fields/preview"
tags: ["Custom Fields"]
---

# Preview Custom Field

`POST /api/v1/custom-fields/preview`

Dry-run a JMESPath against a connector's data, without creating a mapping. Useful for validating an expression before persisting it as a mapping.

## Request body

- CustomFieldPreviewRequest
  - `connector_token` string, required — Connector token to evaluate the JMESPath against.
  - `category` 'HRIS' | 'ATS' | 'LMS', required
  - `model` string, required — Model slug whose raw payload will be evaluated.
  - `json_path` string, required — JMESPath expression to evaluate.
  - `raw_data` object, nullable — Optional inline payload to evaluate against. If omitted, the connector's latest synced row is used (falling back to the integration sample if never synced).

## Response `200`

Successful Response

- CustomFieldPreviewResponse
  - `connector_token` string, required — Connector the JMESPath was evaluated against.
  - `json_path` string, required — JMESPath expression that was evaluated.
  - `resolved_value` string, nullable — The value the JMESPath resolved to. May be of any JSON type or null.
  - `resolved_value_type` string, required — JSON type of the resolved value: 'string', 'number', 'boolean', 'object', 'array', or 'null'.
  - `raw_data_source` string, required — Where the evaluated payload came from: 'connector_sync' (latest synced row), 'integration_sample' (fallback when never synced), or 'inline' (provided in the request body).

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/versions/7da10dc93a21/schema)