IMimprovado
Extraction templates

Load custom setting options

Returns selectable options for a custom extraction setting that is backed by source entities. Use this endpoint when an extraction template exposes a select custom setting with dynamic source metadata and the UI needs to populate its choices for one or more accounts. Account IDs in the request are remote account IDs from the source platform (the same string IDs used by extraction template preview), scoped by the provided connection_id. Search and pagination are applied over the loaded option list by Improvado, so source APIs do not need to support filtering or paging.

post/api/v3/datasources/{datasource_name}/custom_setting_options/

Request

Path parameters

datasource_namestring required

Data source name.

Request body

template_idinteger required

Extraction template ID whose custom setting is being resolved.

connection_idinteger required

Connection ID used to resolve credentials and scope accounts.

account_idsstring[] required

Remote account IDs from the source platform, scoped by connection_id. These are the same string account IDs used by extraction template preview.

custom_setting_namestring required

Custom setting name from the extraction template.

search_querystring

Optional case-insensitive search query applied to loaded options.

pageinteger

Page number for paginated options.

page_sizeinteger

Number of options to return per account.

Example request

{
  "template_id": 10430,
  "connection_id": 20595,
  "account_ids": [
    "47924620"
  ],
  "custom_setting_name": "form_guids",
  "search_query": "contact",
  "page": 1,
  "page_size": 50
}

Response

Custom setting options grouped by account.

custom_setting_namestring

Custom setting name from the request.

Example response

{
  "custom_setting_name": "form_guids",
  "results": [
    {
      "account_id": "47924620",
      "count": 1,
      "results": [
        {
          "value": "801130ad-d745-450a-a974-741b704cbd58",
          "label": "New contact us form",
          "description": "HUBSPOT"
        }
      ],
      "search_applied": true
    }
  ]
}

Changes

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