Tickets

Support tickets for customer service and helpdesk.

Endpoints

• GET /obapi/v1/tickets -- list
• GET /obapi/v1/tickets/{id} -- single

Parameters

page, per_page, status, severity, sort

Status values

Response (list)

{
    "items": [
        {
            "id": "310",
            "ref": "TK2405-0021",
            "track_id": "abc123xyz",
            "subject": "Cannot access invoice PDF",
            "type_label": "Issue",
            "severity_label": "Medium",
            "status": "in_progress",
            "created_at": "2024-05-20T11:00:00Z",
            "updated_at": "2024-05-21T09:30:00Z"
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "ticket": {
        "id": "310",
        "ref": "TK2405-0021",
        "track_id": "abc123xyz",
        "subject": "Cannot access invoice PDF",
        "message": "When I try to download invoice FA2405-0012, I get a 404 error. The invoice appears in the list but the PDF link does not work.",
        "type_code": "ISSUE",
        "type_label": "Issue",
        "category_code": "BILLING",
        "category_label": "Billing",
        "severity_code": "MEDIUM",
        "severity_label": "Medium",
        "resolution": "",
        "progress": 50,
        "origin_email": "customer@example.com",
        "created_at": "2024-05-20T11:00:00Z",
        "updated_at": "2024-05-21T09:30:00Z",
        "read_at": "2024-05-20T11:15:00Z",
        "closed_at": null,
        "last_message_at": "2024-05-21T09:30:00Z",
        "status": "in_progress",
        "public_note": ""
    }
}

Notes

• track_id is a public identifier that can be shared with the customer for tracking.
• progress is a percentage from 0 to 100.
• Tickets have no PDF download endpoint.