HelpWave Developer DocsHelpWave Dev DocsReference-first docs for v1 customers and tickets APIs
GET

/api/v1/tickets/[ticketId]

Fetch a ticket with selected related entities.

Authentication: API key required

Behavior
  • ticketId is parsed as a BigInt for the lookup.
  • The ticket must belong to the authenticated shopDomain.
  • If ticketId is missing, the route returns 400 ticketId is required.
  • If the ticket does not exist inside the authenticated shop, the route returns 404 Ticket not found.
  • The response includes selected fields from the related Customer, User, and HumanTicket records.
  • BigInt values are serialized to strings in the JSON response.
Route parameters
  • ticketId (required)

    Conversation ID represented as a BigInt in the CRM layer.

Response
Response example
{
  "success": true,
  "ticket": {
    "id": "987654321012345678",
    "shopDomain": "example.myshopify.com",
    "Channel": "Mail",
    "name": "Refund request",
    "Customer": {
      "id": 123,
      "email": "dev@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "full_name": "Ada Lovelace",
      "phone_number": "+33123456789",
      "shopify_id": "987654321"
    },
    "User": {
      "id": 45,
      "email": "agent@example.com",
      "first_name": "Grace",
      "last_name": "Hopper",
      "full_name": "Grace Hopper"
    },
    "HumanTicket": {
      "id": 88,
      "HumanTicketStatus": "OPEN",
      "openedAt": "2026-04-28T00:00:00.000Z",
      "closedAt": null
    }
  }
}