THthrivedesk
Inboxes

View an automation

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.

get/inboxes/{inbox_id}/automations/{automation_id}

Request

  • Base URL
    https://api.thrivedesk.com/v1
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

Inbox identifier.

automation_idstring required

Response

Success.

Example response

{
  "data": {
    "id": "2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a",
    "name": "Auto-assign billing questions",
    "automatic": true,
    "active": true,
    "when": {
      "event": "conversation_created"
    },
    "rules": {
      "all": [
        {
          "attribute": "subject",
          "comparison": "contains",
          "value": "refund"
        }
      ]
    },
    "actions": [
      {
        "type": "assign",
        "value": "9c81790c-ae74-4cbd-b2ca-d246ae0df1a9"
      }
    ],
    "created_by": {
      "id": "9c81790c-ae74-4cbd-b2ca-d246ae0df1a9",
      "name": "Alex Morgan",
      "email": "agent@example.com",
      "role": "Administrator"
    },
    "uses_count": 8,
    "last_used_at": "2026-07-10T09:00:00Z",
    "created_at": "2026-07-10T09:00:00Z",
    "updated_at": "2026-07-10T09:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.