Help Webservice

Get open support tickets for a client organization

Get Open Support Tickets For A Client Organization. Tickets are associated to an organziation based on the requester's organization association. This endpoint returns a paginated response sorted by the request date. The first page is indexed at 1 and each page has up to 100 ticket entries.

post/api/help/openTickets

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/help/openTickets
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

pageNumberinteger nullable

Page number used for paginated response. If empty, the search will return the first page.

Response

OK

currentPageinteger nullable

Current page number in the paginated response

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
hasNexPageboolean nullable

True if there is a next page, false otherwise

totalTicketsinteger nullable

Total number of tickets, not limited to the current page

warningMsgstring nullable

Example response

{
  "currentPage": 1,
  "tickets": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "id": 12345,
      "status": "Open",
      "subject": "Camera connectivity issue"
    }
  ]
}

Changes

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