v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Custom Fields

Get Raw Data

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

Query parameters

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

Category of the model.

modelstring required

Model slug whose raw payload should be returned.

Example:employee

Model slug whose raw payload should be returned.

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

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

integration_slugstring nullable

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

Example:workday

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

Response

Successful Response

{"stackTrail":"paths:/api/v1/custom-fields/raw-data:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","title":"Response Get Raw Data Api V1 Custom Fields Raw Data Get"}