---
title: "List actions"
method: GET
path: "/list-actions/{chatbotId}"
tags: ["Chatbot Operations"]
---

# List actions

`GET /list-actions/{chatbotId}`

## Request

- Base URL: `https://api.chat-data.com/api/v2`
- URL: `https://api.chat-data.com/api/v2/list-actions/{chatbotId}`
- Auth: HTTP bearer

Retrieves all configured actions for the specified chatbot.

## Path parameters

- `chatbotId` string, required

## Response `200`

Successfully retrieved actions.

- object
  - `status` 'success'
  - `actions` Action[]: The chatbot's configured actions.
    - `name` string, required: The name of the action. Only letters, numbers, underscores and hyphens are allowed.
    - `description` string, required: Description of when to trigger the action.
    - `type` string, required: 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`.
    - `url` string: For API actions, the URL to call. Use `{name}` placeholders for path parameters.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE': For API actions, the HTTP method.
    - `headers` Header[]: For API actions, the HTTP headers of the request.
      - `name` string, required: The name of the header.
      - `value` string, required: The value of the header.
    - `pathParams` RequestParam[]: For API actions, the URL path parameters.
      - `name` string, required: The name of the parameter.
      - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the parameter.
      - `description` string, required: Description of the parameter.
      - `required` boolean, required: Whether this parameter is required.
      - `static` boolean: Indicates whether the parameter is static. A static parameter always sends its example value instead of a value generated by the chatbot.
      - `example` string: Stringified example value. For non-string types (number, boolean, array, object), the value should be JSON-parseable.
      - `items` RequestParamProperty
        - `name` string, required: The name of the property.
        - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the property.
        - `description` string, required: Description of the property.
        - `required` boolean: Whether this property is required.
        - `items` RequestParamProperty (recursive)
        - `properties` RequestParamProperty[]: For object types, describes the object's properties.
      - `properties` RequestParamProperty[]: For object types, describes the object's properties.
        - `name` string, required: The name of the property.
        - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the property.
        - `description` string, required: Description of the property.
        - `required` boolean: Whether this property is required.
        - `items` RequestParamProperty (recursive)
        - `properties` RequestParamProperty[]: For object types, describes the object's properties.
    - `queryParams` RequestParam[]: For API actions, the URL query parameters.
      - `name` string, required: The name of the parameter.
      - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the parameter.
      - `description` string, required: Description of the parameter.
      - `required` boolean, required: Whether this parameter is required.
      - `static` boolean: Indicates whether the parameter is static. A static parameter always sends its example value instead of a value generated by the chatbot.
      - `example` string: Stringified example value. For non-string types (number, boolean, array, object), the value should be JSON-parseable.
      - `items` RequestParamProperty
        - `name` string, required: The name of the property.
        - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the property.
        - `description` string, required: Description of the property.
        - `required` boolean: Whether this property is required.
        - `items` RequestParamProperty (recursive)
        - `properties` RequestParamProperty[]: For object types, describes the object's properties.
      - `properties` RequestParamProperty[]: For object types, describes the object's properties.
        - `name` string, required: The name of the property.
        - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the property.
        - `description` string, required: Description of the property.
        - `required` boolean: Whether this property is required.
        - `items` RequestParamProperty (recursive)
        - `properties` RequestParamProperty[]: For object types, describes the object's properties.
    - `bodyParams` RequestParam[]: For API actions, the request body parameters.
      - `name` string, required: The name of the parameter.
      - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the parameter.
      - `description` string, required: Description of the parameter.
      - `required` boolean, required: Whether this parameter is required.
      - `static` boolean: Indicates whether the parameter is static. A static parameter always sends its example value instead of a value generated by the chatbot.
      - `example` string: Stringified example value. For non-string types (number, boolean, array, object), the value should be JSON-parseable.
      - `items` RequestParamProperty
        - `name` string, required: The name of the property.
        - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the property.
        - `description` string, required: Description of the property.
        - `required` boolean: Whether this property is required.
        - `items` RequestParamProperty (recursive)
        - `properties` RequestParamProperty[]: For object types, describes the object's properties.
      - `properties` RequestParamProperty[]: For object types, describes the object's properties.
        - `name` string, required: The name of the property.
        - `type` 'string' | 'number' | 'boolean' | 'array' | 'object', required: The data type of the property.
        - `description` string, required: Description of the property.
        - `required` boolean: Whether this property is required.
        - `items` RequestParamProperty (recursive)
        - `properties` RequestParamProperty[]: For object types, describes the object's properties.
    - `includeImages` boolean: For search actions, whether to include images in the results. Defaults to `true`.
    - `prioritizeRecentResults` boolean: For search actions, whether to prioritize recent results.
    - `enableDateRestriction` boolean: For search actions, whether to enable the date restriction.
    - `includedDomains` 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.
    - `link` string: For button actions, the link the button opens. Required for button actions.
    - `label` string: For button actions, the button label. Required for button actions.
    - `enabled` boolean: Whether the action is enabled. New actions are enabled unless this is `false`.
    - `index` integer, required: The position of the action in the chatbot's action list (0-based).
    - `return_file` boolean: Whether the action returns a file.

## Other responses

- `400`: An unexpected error occurred while processing the request; `message` contains the error.
- `401`: Authentication failed: the `Authorization` header is missing or not in the `Bearer <key>` format, the API key does not exist, its workspace is unavailable or has no owner, or the workspace's plan does not include API access. `message` says which.
- `403`: The API key cannot access the requested chatbot. A chatbot-scoped key used with another chatbot's ID gets `Access denied to this chatbot`. A workspace key gets `Chatbot <id> was not found in this API key's workspace. It may have been deleted or moved to another workspace.` when the chatbot does not exist or belongs to another workspace.
- `429`: The workspace sent more than 600 API requests in the last minute. Wait the number of seconds given in the `Retry-After` header (and in `message`) before retrying.

---

[API](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide.md) · [All operations](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide/llms.txt) · [OpenAPI document](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide/revisions/72871007f7f0?raw)