GET
/
api
/
v2
/
integration-schema
/
:slug
/
actions
/
:action_id
Get Action Schema by ID
curl --request GET \
  --url https://api.gocobalt.io/api/v2/integration-schema/:slug/actions/:action_id \
  --header 'Authorization: <authorization>' \
  --header 'linked_account_id: <linked_account_id>' \
  --header 'x-api-key: <api-key>'
[
    {
        "name": "firstname",
        "label": "Enter First Name",
        "required": false,
        "type": "text"
    },
    {
        "name": "lastname",
        "label": "Enter Last Name",
        "required": false,
        "type": "text"
    },
    {
        "name": "email",
        "label": "Enter Email",
        "required": true,
        "type": "text"
    },
    {
        "name": "phone",
        "label": "Enter Phone Number",
        "required": false,
        "type": "text"
    },
    {
        "name": "company",
        "label": "Enter Company Name",
        "required": false,
        "type": "text"
    },
    {
        "name": "website",
        "label": "Enter Website URL",
        "required": false,
        "type": "text"
    },
    {
        "name": "jobtitle",
        "label": "Current job title",
        "required": false,
        "type": "text"
    },
    {
        "name": "hubspot_owner_id",
        "label": "Enter Owner Id",
        "required": false,
        "type": "text"
    },
    {
        "name": "associations",
        "label": "Associations",
        "required": false,
        "type": "json"
    },
    {
        "name": "additional_fields",
        "label": "Additional Fields",
        "required": false,
        "type": "json"
    }
]

This API retrieves the parameter schema for a specific action within an integration application. Use this to understand what parameters are required or optional for executing an action.

​
Request description

This API supports two authentication methods. You can use either Session Token authentication OR the combination of API key and linked account ID.

​
Authentication Option 1: Session Token

​
Authorization
string
required

Bearer token using your session token for authentication

Format: Bearer YOUR_SESSION_TOKEN

​
Authentication Option 2: API Key + Linked Account

​
x-api-key
string
required

Your Cobalt API key

​
linked_account_id
string
required

The unique identifier for the linked account

​
Path Parameters

​
slug
string
required

The unique identifier for the integration application (e.g., “hubspot”, “salesforce”)

​
action_id
string
required

The unique identifier for the specific action (e.g., “create_contact”, “create_deal”)

​
Response description

​
parameters
array

Array of parameter objects required for the action

[
    {
        "name": "firstname",
        "label": "Enter First Name",
        "required": false,
        "type": "text"
    },
    {
        "name": "lastname",
        "label": "Enter Last Name",
        "required": false,
        "type": "text"
    },
    {
        "name": "email",
        "label": "Enter Email",
        "required": true,
        "type": "text"
    },
    {
        "name": "phone",
        "label": "Enter Phone Number",
        "required": false,
        "type": "text"
    },
    {
        "name": "company",
        "label": "Enter Company Name",
        "required": false,
        "type": "text"
    },
    {
        "name": "website",
        "label": "Enter Website URL",
        "required": false,
        "type": "text"
    },
    {
        "name": "jobtitle",
        "label": "Current job title",
        "required": false,
        "type": "text"
    },
    {
        "name": "hubspot_owner_id",
        "label": "Enter Owner Id",
        "required": false,
        "type": "text"
    },
    {
        "name": "associations",
        "label": "Associations",
        "required": false,
        "type": "json"
    },
    {
        "name": "additional_fields",
        "label": "Additional Fields",
        "required": false,
        "type": "json"
    }
]