Sources

Get Source Field Options

Fetches the dropdown / dynamic option values for one of a source's payload fields. Use it when building a source's preview / create payload whose field expects a value from a connected integration (HubSpot lists, HubSpot properties per object type, etc.).

Pass the source_id (same identifier used by the source's preview / create endpoints, e.g. import_from_hubspot) and the field_name. Behaves like the workflow Get Action Field Options endpoint, so resolver behavior is consistent across the two surfaces.

Cascading resolvers (e.g. HubSpot: pick object_type → list hubspot_properties) take their parent selection via context. Calling a cascading resolver without the required key returns a 400 with the accepted key spellings. hubspot_lists takes an optional context.search (words matched against list names) to find a list by name without pulling the whole catalog.

Returns options as { value, label, extras? }. value is what to send back in the source's payload; extras carries per-integration metadata when relevant.

post/api/v1/sources/{source_id}/options/{field_name}

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

source_idstring required

Source identifier — same as on the source's preview / create endpoint.

field_namestring required

Snake-cased payload field name to fetch options for. Matches the keys on the source's preview / create body.

Request body

contextobject

Optional context for cascading resolvers. Keys are snake-cased and match the parent field's public name on the source's payload. Resolvers accept multiple snake-cased spellings — calling without a required key returns 400 listing the accepted spellings. hubspot_lists also accepts an optional search key: words matched against list names (case-insensitive) so a list can be found by name instead of pulling the whole catalog.

Response

Default Response

statusinteger

Changes

No recorded changes to this operation across all 1 revision of this API.