Skip to main content
POST
/
api
/
v1
/
custom-fields
/
preview
Preview Custom Field
curl --request POST \
  --url https://api.bindbee.dev/api/v1/custom-fields/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_token": "<string>",
  "category": "HRIS",
  "model": "<string>",
  "json_path": "<string>",
  "raw_data": null
}
'
{
  "connector_token": "<string>",
  "json_path": "<string>",
  "resolved_value_type": "<string>",
  "raw_data_source": "<string>",
  "resolved_value": "+1-555-123-4567"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bindbee.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
connector_token
string
required

Connector token to evaluate the JMESPath against.

Example:

"i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"

​
category
enum<string>
required

Category of the model.

Available options:
HRIS,
ATS,
LMS
Example:

"HRIS"

​
model
string
required

Model slug whose raw payload will be evaluated.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_-]*$
Example:

"employee"

​
json_path
string
required

JMESPath expression to evaluate.

Maximum string length: 1024
Pattern: \S.*\S
Example:

"data.employee.guardian_mobile"

​
raw_data
Raw Data · object

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:

null

Response

Successful Response

​
connector_token
string
required

Connector the JMESPath was evaluated against.

Example:

"i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"

​
json_path
string
required

JMESPath expression that was evaluated.

Example:

"data.employee.guardian_mobile"

​
resolved_value_type
string
required

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

Example:

"string"

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

Example:

"connector_sync"

​
resolved_value
any | null

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

Example:

"+1-555-123-4567"