Skip to main content
POST
/
api
/
v2
/
integration-schema
/
:slug
/
actions
/
:action_id
/
execute
curl -X POST "https://app.refold.ai/api/v2/integration-schema/{slug}/actions/get_contact/execute" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{ "limit": "1" }'
{
  "node_status": "Success",
  "data": {
    "results": [
      {
        "id": "51",
        "properties": {
          "email": "contact@example.com",
          "firstname": "Brian",
          "lastname": "Halligan (Sample Contact)",
          "createdate": "2023-10-06T09:53:17.242Z"
        },
        "createdAt": "2023-10-06T09:53:17.242Z",
        "updatedAt": "2024-05-15T18:35:12.877Z",
        "archived": false
      }
    ],
    "paging": {}
  }
}
Execute an action against a linked account’s connected application. The request body holds the action’s parameters, as described by its parameter schema. Refold uses the linked account’s stored credentials automatically — you don’t put app tokens in the body.
Write actions (create / update / delete) make real changes in the connected application. Test with read actions (e.g. get_contact, search_contacts) first.

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 to execute. Example: get_contact

Body Parameters

{parameter}
any
One key per parameter from the action’s schema. Required parameters must be present.

Response

node_status
string
Execution status, e.g. Success.
data
object
The action’s result, in the application’s native shape.
{
  "node_status": "Success",
  "data": {
    "results": [
      {
        "id": "51",
        "properties": {
          "email": "contact@example.com",
          "firstname": "Brian",
          "lastname": "Halligan (Sample Contact)",
          "createdate": "2023-10-06T09:53:17.242Z"
        },
        "createdAt": "2023-10-06T09:53:17.242Z",
        "updatedAt": "2024-05-15T18:35:12.877Z",
        "archived": false
      }
    ],
    "paging": {}
  }
}
curl -X POST "https://app.refold.ai/api/v2/integration-schema/{slug}/actions/get_contact/execute" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{ "limit": "1" }'