> ## 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.

# Preview

> Dry-run a JMESPath against a connector's data without persisting it as a mapping. Use this to validate an expression before saving.



## OpenAPI

````yaml post /api/v1/custom-fields/preview
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers:
  - url: https://api.bindbee.dev
  - url: https://api-eu.bindbee.dev
security: []
paths:
  /api/v1/custom-fields/preview:
    post:
      tags:
        - Custom Fields
      summary: Preview Custom Field
      description: >-
        Dry-run a JMESPath against a connector's data, without creating a
        mapping. Useful for validating an expression before persisting it as a
        mapping.
      operationId: preview_custom_field_api_v1_custom_fields_preview_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldPreviewRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldPreviewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    CustomFieldPreviewRequest:
      properties:
        connector_token:
          type: string
          title: Connector Token
          description: Connector token to evaluate the JMESPath against.
          examples:
            - i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T
        category:
          $ref: '#/components/schemas/Category'
          description: Category of the model.
          examples:
            - HRIS
        model:
          type: string
          maxLength: 64
          pattern: ^[a-z][a-z0-9_-]*$
          title: Model
          description: Model slug whose raw payload will be evaluated.
          examples:
            - employee
        json_path:
          type: string
          maxLength: 1024
          pattern: \S.*\S
          title: Json Path
          description: JMESPath expression to evaluate.
          examples:
            - data.employee.guardian_mobile
        raw_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Raw Data
          description: >-
            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).
          examples:
            - null
      type: object
      required:
        - connector_token
        - category
        - model
        - json_path
      title: CustomFieldPreviewRequest
    CustomFieldPreviewResponse:
      properties:
        connector_token:
          type: string
          title: Connector Token
          description: Connector the JMESPath was evaluated against.
          examples:
            - i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T
        json_path:
          type: string
          title: Json Path
          description: JMESPath expression that was evaluated.
          examples:
            - data.employee.guardian_mobile
        resolved_value:
          anyOf:
            - {}
            - type: 'null'
          title: Resolved Value
          description: The value the JMESPath resolved to. May be of any JSON type or null.
          examples:
            - +1-555-123-4567
        resolved_value_type:
          type: string
          title: Resolved Value Type
          description: >-
            JSON type of the resolved value: 'string', 'number', 'boolean',
            'object', 'array', or 'null'.
          examples:
            - string
        raw_data_source:
          type: string
          title: Raw Data Source
          description: >-
            Where the evaluated payload came from: 'connector_sync' (latest
            synced row), 'integration_sample' (fallback when never synced), or
            'inline' (provided in the request body).
          examples:
            - connector_sync
      type: object
      required:
        - connector_token
        - json_path
        - resolved_value_type
        - raw_data_source
      title: CustomFieldPreviewResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Category:
      type: string
      enum:
        - HRIS
        - ATS
        - LMS
      title: Category
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````