Get an action

gethttps://api.chat-data.com/api/v2/get-action/{chatbotId}/get-action/{chatbotId}

Any keyWorkspace or chatbot key

Retrieves a specific action by name or index for the specified chatbot. Send exactly one of name or index.

Parameters

Sending 2 of 3 fields

Required

chatbotIdstring

The unique identifier allocated to the chatbot.

Also sending

indexinteger

The index of the action to retrieve (mutually exclusive with name).

Try it · GET /get-action/{chatbotId}

curl 'https://api.chat-data.com/api/v2/get-action/6650f1c2a9e4b83d2c7a1f05?index=0' \  -H "Authorization: Bearer $CHAT_DATA_API_KEY"

Loading…

{  "status": "success",  "action": {    "index": 0,    "name": "stockPriceLookup",    "description": "The user wants to know the current stock price of a company",    "type": "api",    "url": "https://api.example.com/stocks/{symbol}/price",    "method": "GET",    "headers": [      {        "name": "Authorization",        "value": "Bearer stk_live_3f9a2c7d1e"      }    ],    "pathParams": [      {        "name": "symbol",        "type": "string",        "description": "The stock ticker symbol to look up.",        "required": true,        "example": "AAPL"      }    ],    "return_file": false  }}

Responses

Successfully retrieved action.

Content type: application/json

Field	Type	Description
statusstring	string	One of: `success`.
actionobject	object	The action.
action.namestring	string	The name of the action. Only letters, numbers, underscores and hyphens are allowed.
action.descriptionstring	string	Description of when to trigger the action.
action.typestring	string	The type of action. Besides `api`, `search`, `lead` and `button`, actions created in the dashboard can have other types, such as `scrape`, `document`, `order_tracking`, `appointment-ui`, `mcp` or `workflow_action`.
action.urlstring	string	For API actions, the URL to call. Use `{name}` placeholders for path parameters.
action.methodstring	string	For API actions, the HTTP method. One of: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`.
action.headersarray of object	array of object	For API actions, the HTTP headers of the request.
action.headers[].namestring	string	The name of the header.
action.headers[].valuestring	string	The value of the header.
action.pathParamsarray of object	array of object	For API actions, the URL path parameters.
action.pathParams[].namestring	string	The name of the parameter.
action.pathParams[].typestring	string	The data type of the parameter. One of: `string`, `number`, `boolean`, `array`, `object`.
action.pathParams[].descriptionstring	string	Description of the parameter.
action.pathParams[].requiredboolean	boolean	Whether this parameter is required.
action.pathParams[].staticboolean	boolean	Indicates whether the parameter is static. A static parameter always sends its example value instead of a value generated by the chatbot.
action.pathParams[].examplestring	string	Stringified example value. For non-string types (number, boolean, array, object), the value should be JSON-parseable.
action.pathParams[].itemsobject	object	For array types, describes the array items.
action.pathParams[].items.namestring	string	The name of the property.
action.pathParams[].items.typestring	string	The data type of the property. One of: `string`, `number`, `boolean`, `array`, `object`.
action.pathParams[].items.descriptionstring	string	Description of the property.
action.pathParams[].items.requiredboolean	boolean	Whether this property is required.
action.pathParams[].items.itemsobject	object
action.pathParams[].items.propertiesarray of object	array of object	For object types, describes the object's properties.
action.pathParams[].propertiesarray of object	array of object	For object types, describes the object's properties.
action.pathParams[].properties[].namestring	string	The name of the property.
action.pathParams[].properties[].typestring	string	The data type of the property. One of: `string`, `number`, `boolean`, `array`, `object`.
action.pathParams[].properties[].descriptionstring	string	Description of the property.
action.pathParams[].properties[].requiredboolean	boolean	Whether this property is required.
action.pathParams[].properties[].itemsobject	object
action.pathParams[].properties[].propertiesarray of object	array of object	For object types, describes the object's properties.
action.queryParamsarray of object	array of object	For API actions, the URL query parameters.
action.queryParams[].namestring	string	The name of the parameter.
action.queryParams[].typestring	string	The data type of the parameter. One of: `string`, `number`, `boolean`, `array`, `object`.
action.queryParams[].descriptionstring	string	Description of the parameter.
action.queryParams[].requiredboolean	boolean	Whether this parameter is required.
action.queryParams[].staticboolean	boolean	Indicates whether the parameter is static. A static parameter always sends its example value instead of a value generated by the chatbot.
action.queryParams[].examplestring	string	Stringified example value. For non-string types (number, boolean, array, object), the value should be JSON-parseable.
action.queryParams[].itemsobject	object	For array types, describes the array items.
action.queryParams[].items.namestring	string	The name of the property.
action.queryParams[].items.typestring	string	The data type of the property. One of: `string`, `number`, `boolean`, `array`, `object`.
action.queryParams[].items.descriptionstring	string	Description of the property.
action.queryParams[].items.requiredboolean	boolean	Whether this property is required.
action.queryParams[].items.itemsobject	object
action.queryParams[].items.propertiesarray of object	array of object	For object types, describes the object's properties.
action.queryParams[].propertiesarray of object	array of object	For object types, describes the object's properties.
action.queryParams[].properties[].namestring	string	The name of the property.
action.queryParams[].properties[].typestring	string	The data type of the property. One of: `string`, `number`, `boolean`, `array`, `object`.
action.queryParams[].properties[].descriptionstring	string	Description of the property.
action.queryParams[].properties[].requiredboolean	boolean	Whether this property is required.
action.queryParams[].properties[].itemsobject	object
action.queryParams[].properties[].propertiesarray of object	array of object	For object types, describes the object's properties.
action.bodyParamsarray of object	array of object	For API actions, the request body parameters.
action.bodyParams[].namestring	string	The name of the parameter.
action.bodyParams[].typestring	string	The data type of the parameter. One of: `string`, `number`, `boolean`, `array`, `object`.
action.bodyParams[].descriptionstring	string	Description of the parameter.
action.bodyParams[].requiredboolean	boolean	Whether this parameter is required.
action.bodyParams[].staticboolean	boolean	Indicates whether the parameter is static. A static parameter always sends its example value instead of a value generated by the chatbot.
action.bodyParams[].examplestring	string	Stringified example value. For non-string types (number, boolean, array, object), the value should be JSON-parseable.
action.bodyParams[].itemsobject	object	For array types, describes the array items.
action.bodyParams[].items.namestring	string	The name of the property.
action.bodyParams[].items.typestring	string	The data type of the property. One of: `string`, `number`, `boolean`, `array`, `object`.
action.bodyParams[].items.descriptionstring	string	Description of the property.
action.bodyParams[].items.requiredboolean	boolean	Whether this property is required.
action.bodyParams[].items.itemsobject	object
action.bodyParams[].items.propertiesarray of object	array of object	For object types, describes the object's properties.
action.bodyParams[].propertiesarray of object	array of object	For object types, describes the object's properties.
action.bodyParams[].properties[].namestring	string	The name of the property.
action.bodyParams[].properties[].typestring	string	The data type of the property. One of: `string`, `number`, `boolean`, `array`, `object`.
action.bodyParams[].properties[].descriptionstring	string	Description of the property.
action.bodyParams[].properties[].requiredboolean	boolean	Whether this property is required.
action.bodyParams[].properties[].itemsobject	object
action.bodyParams[].properties[].propertiesarray of object	array of object	For object types, describes the object's properties.
action.includeImagesboolean	boolean	For search actions, whether to include images in the results. Defaults to `true`.
action.prioritizeRecentResultsboolean	boolean	For search actions, whether to prioritize recent results.
action.enableDateRestrictionboolean	boolean	For search actions, whether to enable the date restriction.
action.includedDomainsarray of string	array of string	For search actions, the domains to restrict the web search to, as full URLs (for example `https://www.example.com`). Leave empty to search all domains.
action.linkstring	string	For button actions, the link the button opens. Required for button actions.
action.labelstring	string	For button actions, the button label. Required for button actions.
action.enabledboolean	boolean	Whether the action is enabled. New actions are enabled unless this is `false`.
action.indexinteger	integer	The position of the action in the chatbot's action list (0-based).
action.return_fileboolean	boolean	Whether the action returns a file.

Example

{  "status": "success",  "action": {    "index": 0,    "name": "stockPriceLookup",    "description": "The user wants to know the current stock price of a company",    "type": "api",    "url": "https://api.example.com/stocks/{symbol}/price",    "method": "GET",    "headers": [      {        "name": "Authorization",        "value": "Bearer stk_live_3f9a2c7d1e"      }    ],    "pathParams": [      {        "name": "symbol",        "type": "string",        "description": "The stock ticker symbol to look up.",        "required": true,        "example": "AAPL"      }    ],    "return_file": false  }}

Last updated October 14, 2026