---
title: "GET /api/v1/agents/{agentId}/automations/{automationId}"
method: GET
path: "/api/v1/agents/{agentId}/automations/{automationId}"
tags: ["automations"]
---

# GET /api/v1/agents/{agentId}/automations/{automationId}

`GET /api/v1/agents/{agentId}/automations/{automationId}`

## Request

- Base URL: `https://api.clerkchat.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.clerkchat.co/api/v1/agents/{agentId}/automations/{automationId}`
- Auth: none required

## Path parameters

- `agentId` string, required
- `automationId` string, required

## Response `200`

Automation

- AutomationEncoded
  - `id` string, required
  - `organizationId` string, required
  - `agentId` string, required
  - `name` string, required
  - `trigger` object, required
    - `type` 'model.instruction', required
    - `version` 1, required
    - `whenToUse` string, required
    - `channels` string[], required
  - `action` union, required
    - object
      - `type` 'suggested_messages', required
      - `version` 1, required
      - `mode` 'auto' | 'manual', required
      - `messages` string[], required
      - `disableInput` boolean, required
    - object
      - `type` 'custom_button', required
      - `version` 1, required
      - `buttonText` string, required
      - `url` string, required
      - `actionName` string, nullable
    - object
      - `type` 'collect_leads', required
      - `version` 2, required
      - `fields` object[], required
        - `id` string, required
        - `label` string, required
        - `kind` 'text' | 'email' | 'phone' | 'textarea', required
        - `required` boolean, required
        - `maxLength` integer, nullable, required
      - `successMessage` string, required
      - `dismissMessage` string, required
      - `notification` union, required
        - object
          - `kind` 'none', required
        - object
          - `kind` 'slack', required
          - `channelId` string, nullable, required
          - `template` string, nullable, required
    - object
      - `type` 'slack', required
      - `version` 1, required
      - `channelId` string, nullable, required
      - `template` string, required
    - object
      - `type` 'escalate', required
      - `version` 1, required
      - `ticketPlatform` 'intercom' | 'zendesk'
      - `stopAi` boolean, required
      - `confirmationMessage` string, required
    - object
      - `type` 'custom_action', required
      - `version` 1, required
      - `method` 'GET' | 'POST', required
      - `url` string, required
      - `headers` object, required
      - `bodyTemplate` string, nullable, required
      - `inputs` object[], required
        - `name` string, required
        - `description` string, required
        - `required` boolean, required
      - `dataAccess` 'full' | 'summary', required
    - object
      - `type` 'shopify_products', required
      - `version` 1, required
    - object
      - `type` 'shopify_get_cart', required
      - `version` 1, required
    - object
      - `type` 'shopify_update_cart', required
      - `version` 1, required
    - object
      - `type` 'stripe_get_subscription', required
      - `version` 1, required
    - object
      - `type` 'stripe_get_invoices', required
      - `version` 1, required
    - object
      - `type` 'stripe_update_customer', required
      - `version` 1, required
    - object
      - `type` 'stripe_cancel_subscription', required
      - `version` 1, required
  - `state` union, required
    - object
      - `status` 'draft', required
    - object
      - `status` 'enabled', required
      - `enabledAt` integer, required
    - object
      - `status` 'disabled', required
      - `disabledAt` integer, required
  - `revision` integer, required
  - `createdByUserId` string, nullable, required
  - `updatedByUserId` string, nullable, required
  - `createdAt` integer, required
  - `updatedAt` integer, required

## Other responses

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Forbidden
- `404`: NotFound
- `500`: InvalidStoredData
- `503`: PersistenceUnavailable

---

[API](https://skmtc.dev/clerkchat/apis/clerk-chat-api.md) · [All operations](https://skmtc.dev/clerkchat/apis/clerk-chat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/clerkchat/apis/clerk-chat-api/revisions/cc318e39e1d0?raw)