v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Custom Fields

Preview Custom Field

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

post/api/v1/custom-fields/preview

Request body

connector_tokenstring required

Connector token to evaluate the JMESPath against.

category'HRIS' | 'ATS' | 'LMS' required

modelstring required

Model slug whose raw payload will be evaluated.

json_pathstring required

JMESPath expression to evaluate.

raw_dataobject 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).

Example request

{
  "connector_token": "i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T",
  "model": "employee",
  "json_path": "data.employee.guardian_mobile"
}

Response

Successful Response

connector_tokenstring required

Connector the JMESPath was evaluated against.

json_pathstring required

JMESPath expression that was evaluated.

resolved_valuestring nullable

The value the JMESPath resolved to. May be of any JSON type or null.

resolved_value_typestring required

JSON type of the resolved value: 'string', 'number', 'boolean', 'object', 'array', or 'null'.

raw_data_sourcestring 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).

Example response

{
  "connector_token": "i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T",
  "json_path": "data.employee.guardian_mobile",
  "resolved_value": "+1-555-123-4567",
  "resolved_value_type": "string",
  "raw_data_source": "connector_sync"
}