API documentation

GET /agent_messages/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/agent_messages/:id

Get Agent Message by id.

Retrieves a single Agent Message by id, scoped to your company.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/agent_messages/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "agent_message": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "AgentMessage",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": "/agent_messages/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "content": "This is an example broadcast message to agents.",
    "agent_status_id": null,
    "user_id": 10002,
    "agent_widget_count": 1
  },
  "metadata": {
    "root": "agent_message"
  }
}