Get All Config Fields

Get all configurable fields and workflows for an app’s config.

POST /api/v2/public/config/field

cURL (API key)

curl -X POST "https://app.refold.ai/api/v2/public/config/field" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID" \
  -H "slug: {slug}" \
  -H "Content-Type: application/json" \
  -d '{}'

200

{
  "slug": "hubspot",
  "field_errors": [],
  "fields": [
    {
      "id": "699fec7a5bd27ed2af7243ad",
      "name": "Select",
      "field_type": "select",
      "required": false,
      "multiple": true,
      "hidden": false,
      "options": [
        { "name": "A", "value": "A" },
        { "name": "B", "value": "B" },
        { "name": "C", "value": "C" }
      ],
      "defaultValue": ""
    }
  ],
  "workflows": []
}

Return the configured fields and workflows for an app’s config on a linked account. This is a POST because field datasources may accept a payload when resolving options. Use it to render a configuration UI for the connected app.

Authentication

This endpoint is scoped to a linked account, so it accepts either authentication method.

Option 1 — API key

x-api-key · string

Your Refold API key.

linked_account_id · string

The linked account whose config to read.

Option 2 — Session token

Authorization · string

Session token. Format: Bearer YOUR_SESSION_TOKEN

Headers

slug · string · required

The app slug whose config to read.

Example: hubspot

Response

200 OK

slug · string

The app slug.

fields · array

Configurable fields.

Show properties

id · string

Field ID.

name · string

Field label.

field_type · string

Type: text, number, select, date, email, json, map, map_v2, …

required · boolean

Whether the field is required.

multiple · boolean

Whether multiple values are allowed.

options · array

Available options for select fields.

defaultValue · any

Default value.

workflows · array

Workflows available in this config.

field_errors · array

Any errors resolving field datasources.

401 Unauthorized

status_code · integer

HTTP status code.

http_error_type · string

Error category.

error · string

Internal error code.

message · string

Human-readable error description.

200

{
  "slug": "hubspot",
  "field_errors": [],
  "fields": [
    {
      "id": "699fec7a5bd27ed2af7243ad",
      "name": "Select",
      "field_type": "select",
      "required": false,
      "multiple": true,
      "hidden": false,
      "options": [
        { "name": "A", "value": "A" },
        { "name": "B", "value": "B" },
        { "name": "C", "value": "C" }
      ],
      "defaultValue": ""
    }
  ],
  "workflows": []
}

cURL (API key)

curl -X POST "https://app.refold.ai/api/v2/public/config/field" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID" \
  -H "slug: {slug}" \
  -H "Content-Type: application/json" \
  -d '{}'