BIbindbee
Custom Fields

Get Raw Data

Changed on

Inspect the raw upstream payload for a connector + (category, model). Use this to discover the field structure before writing a JMESPath. Returns the latest synced row's raw_data; falls back to the integration's canned sample if the connector has never synced. Provide exactly one of connector_token or integration_slug.

get/api/v1/custom-fields/raw-data

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

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

Category of the model.

modelstring required

Model slug whose raw payload should be returned.

Example:employee
connector_tokenstring nullable

Connector token used to return the connector's latest synced row. Exactly one of connector_token or integration_slug is required.

Example:i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T
integration_slugstring nullable

Integration slug used to return the canned integration sample. Exactly one of connector_token or integration_slug is required.

Example:workday

Response

Successful Response

object nullable required

Changes

  • a606b0cf18c9Revision changes
    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

  • eb3486b88e55Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status