> ## Documentation Index
> Fetch the complete documentation index at: https://chatbase.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List actions

> Returns a paginated list of an agent's actions, sorted by name. Action configuration is not included.



## OpenAPI

````yaml /api-v2-openapi.json get /agents/{agentId}/actions
openapi: 3.1.0
info:
  title: Chatbase API v2
  version: 2.0.0
  description: >-
    Chatbase API v2 - A robust, structured API for managing agents,
    conversations, and the helpdesk.
servers:
  - url: https://www.chatbase.co/api/v2
    description: Chatbase API v2
security: []
paths:
  /agents/{agentId}/actions:
    get:
      tags:
        - Actions
      summary: List actions
      description: >-
        Returns a paginated list of an agent's actions, sorted by name. Action
        configuration is not included.
      operationId: listActions
      parameters:
        - schema:
            type: string
            minLength: 1
            description: The agent ID
            example: 5QHA6VB-DIAbBhxwqxfdi
          required: true
          description: The agent ID
          name: agentId
          in: path
        - schema:
            type: string
            description: Opaque cursor from a previous response to fetch the next page
            example: eyJ0IjoiMjAyNC0wMS0xNVQxMDozMDowMC4wMDBaIiwiaWQiOiJhYmMxMjMifQ==
          required: false
          description: Opaque cursor from a previous response to fetch the next page
          name: cursor
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: Number of items per page (1 to 100, default 20)
            example: 20
          required: false
          description: Number of items per page (1 to 100, default 20)
          name: limit
          in: query
      responses:
        '200':
          description: Paginated list of actions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListActionsResponse'
        '400':
          description: >-
            The request body failed schema validation. Inspect the `details`
            object in the error response for field-level errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: VALIDATION_INVALID_BODY
                  message: Invalid request
        '401':
          description: >-
            No Authorization header present. Provide a valid API key as a Bearer
            token in the Authorization header: `Authorization: Bearer
            <api-key>`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: AUTH_MISSING_API_KEY
                  message: Authentication required
        '403':
          description: >-
            Your current plan does not include API access. Upgrade to the Basic
            plan or higher to use the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: SUBSCRIPTION_API_RESTRICTED_PLAN
                  message: A Basic plan or higher is required to access the API
        '404':
          description: >-
            No agent matches the provided `agentId`, or it does not belong to
            the authenticated account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: AGENT_NOT_FOUND
                  message: Agent not found
        '429':
          description: >-
            Rate limit exceeded. Check the `X-RateLimit-Reset` response header
            for the Unix epoch seconds when the limit resets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: RATE_LIMIT_TOO_MANY_REQUESTS
                  message: Too many requests, please try again later
        '500':
          description: >-
            An unhandled server error occurred. If the issue persists, contact
            support with the `x-request-id` response header value for debugging.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: INTERNAL_SERVER_ERROR
                  message: Something went wrong, please try again
        '503':
          description: >-
            Chatbase is undergoing scheduled maintenance and the API is
            temporarily rejecting requests. This is transient; retry after a
            short delay. Requests are rejected before any data is read or
            written, so no partial changes are applied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: SERVICE_UNDER_MAINTENANCE
                  message: >-
                    The API is temporarily unavailable for scheduled
                    maintenance, please try again later
      security:
        - bearerAuth: []
components:
  schemas:
    ListActionsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ActionListItem'
        pagination:
          type: object
          properties:
            cursor:
              type:
                - string
                - 'null'
              description: Cursor for the next page, or null if no more pages
            hasMore:
              type: boolean
              description: Whether more results are available
            total:
              type: number
              description: Total number of items matching the query
          required:
            - cursor
            - hasMore
            - total
      required:
        - data
        - pagination
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
            details:
              type: object
              additionalProperties:
                type: string
              description: Field-level validation errors
          required:
            - code
            - message
      required:
        - error
    ActionListItem:
      type: object
      properties:
        id:
          type: string
          description: Action ID
        name:
          type: string
          description: Action name, unique within the agent
        type:
          type: string
          enum:
            - collect-leads
            - collect-data
            - custom-button
            - custom-action
            - shopify-get-cart
            - shopify-update-cart
            - shopify-place-order
            - shopify-exchange
            - shopify-show-product
            - shopify-show-order
            - shopify-update-profile
            - shopify-update-address
            - shopify-account-access
            - shopify-get-metafields
            - shopify-tag-order
            - shopify-create-return
            - magento-show-product
            - slack-notify
            - stripe-get-subscription-info
            - stripe-get-invoices
            - stripe-change-billing-address
            - stripe-manage-subscription
            - stripe-find-payments
            - stripe-refund-payment
            - chatbase-update-chatbot-settings
            - calcom-get-slots
            - calendly-get-slots
            - tavily-web-search
            - sunshine-live-chat
            - zendesk-messaging-live-chat
            - freshchat-live-chat
            - salesforce-live-chat
            - chatbase-live-chat
            - customize-suggested-messages
            - custom-form
            - create-ticket
            - transfer-to-phone-number
            - human-in-the-loop
          description: Action type
          example: custom-action
        status:
          type: string
          enum:
            - enabled
            - disabled
            - draft
          description: >-
            Whether the agent can use the action. `draft` means its setup isn't
            complete, so the agent can't use it.
        procedureOnly:
          type: boolean
          description: Whether the action runs only when a procedure calls it
      required:
        - id
        - name
        - type
        - status
        - procedureOnly
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from your account settings

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.