---
title: "View an automation"
method: GET
path: "/inboxes/{inbox_id}/automations/{automation_id}"
tags: ["Inboxes"]
---

# View an automation

`GET /inboxes/{inbox_id}/automations/{automation_id}`

## Request

- Base URL: `https://api.thrivedesk.com/v1`
- URL: `https://api.thrivedesk.com/v1/inboxes/{inbox_id}/automations/{automation_id}`
- Auth: HTTP bearer

View an automation.

Personal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.

## Path parameters

- `inbox_id` string, required
- `automation_id` string, required

## Response `200`

Success.

- AutomationResponse
  - `data` Automation, required
    - `id` string
    - `name` string
    - `automatic` boolean
    - `active` boolean
    - `when` object: Trigger definition (free-form, see Automation docs).
    - `rules` object: Rule definition. Array-of-conditions form when paired with multiple rules, single object form otherwise.
    - `actions` object[]: Actions to perform when the automation fires.
    - `created_by` User: A teammate (agent, admin, or owner) on the organization.
      - `id` string
      - `name` string
      - `first_name` string
      - `last_name` string
      - `email` string, email
      - `phone` string, nullable
      - `job_title` string, nullable
      - `avatar` string, uri, nullable
      - `role` 'Account Owner' | 'Administrator' | 'User'
      - `presence` 'online' | 'away' | 'null', nullable
      - `timezone` string, nullable
      - `time_format` string, nullable: 12h or 24h.
      - `active_organization_id` string, nullable
      - `created_at` string, date-time
      - `extra` object: Per-user preferences.
        - `password_reset_required` boolean
        - `notification_preferences` object
        - `firebase_notification_preferences` object
        - `mobile_notification_preferences` object
        - `auto_advance_ticket_enabled` boolean
        - `undo_send_enabled` boolean
        - `undo_send_delay` integer, nullable
    - `uses_count` integer, nullable
    - `last_used_at` string, date-time, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `401`: Missing or invalid bearer token.
- `403`: Token is valid but does not include a required scope, or the user does not have access to the resource.
- `404`: Resource not found.
- `422`: Request body failed validation.
- `429`: Rate limit exceeded. The `Retry-After` header indicates how long to wait before retrying. See [Pagination and rate limits](/get-started/pagination) for the full rate-limit policy.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/thrivedesk/apis/thrivedesk-public-api.md) - [All operations](https://skmtc.dev/thrivedesk/apis/thrivedesk-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thrivedesk/apis/thrivedesk-public-api/revisions/dce9c632a018?raw)