Skip to main content
GET
/
api
/
v2
/
integration-schema
/
:slug
/
actions
/
:action_id
curl -X GET "https://app.refold.ai/api/v2/integration-schema/{slug}/actions/{action_id}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID"

[
  { "name": "propertyName", "label": "Enter property name", "required": true, "type": "text" },
  { "name": "operator", "label": "Enter operator", "required": true, "type": "text" },
  { "name": "value", "label": "Enter value", "required": true, "type": "text" },
  { "name": "query", "label": "Enter Query", "required": false, "type": "text" },
  { "name": "limit", "label": "Enter Limit", "required": false, "type": "text" }
]
Return the parameter schema for a specific action. Use it to know which fields to send when you execute the action — including which are required.

​
Authentication

​
x-api-key
string
required
Your Refold API key. Find it in Settings → Credentials.
​
linked_account_id
string
required
The linked account whose connection to use.

​
Path Parameters

​
slug
string
required
The application slug. Example: hubspot
​
action_id
string
required
The action ID (from List Actions). Example: search_contacts

​
Response

Returns an array of parameter definitions.
​
name
string
Parameter key to send when executing.
​
label
string
Display label.
​
required
boolean
Whether the parameter is required.
​
type
string
Input type, e.g. text.
[
  { "name": "propertyName", "label": "Enter property name", "required": true, "type": "text" },
  { "name": "operator", "label": "Enter operator", "required": true, "type": "text" },
  { "name": "value", "label": "Enter value", "required": true, "type": "text" },
  { "name": "query", "label": "Enter Query", "required": false, "type": "text" },
  { "name": "limit", "label": "Enter Limit", "required": false, "type": "text" }
]

curl -X GET "https://app.refold.ai/api/v2/integration-schema/{slug}/actions/{action_id}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID"