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

Get open support tickets for a client organization

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/help/openTickets \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "pageNumber": 123
}
'

200

{
  "currentPage": 1,
  "error": true,
  "errorMsg": "<string>",
  "hasNexPage": true,
  "tickets": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "id": 12345,
      "status": "Open",
      "subject": "Camera connectivity issue"
    }
  ],
  "totalTickets": 123,
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for retrieving open support tickets with pagination.

pageNumber · integer<int32> | null

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

Response

200 - application/json

OK

Response object containing open support tickets with pagination information.

currentPage · integer<int32> | null

Current page number in the paginated response

Example:

1

error · boolean | null

errorMsg · string | null

hasNexPage · boolean | null

True if there is a next page, false otherwise

tickets · object[] | null

List of open support tickets

Show child attributes

totalTickets · integer<int32> | null

Total number of tickets, not limited to the current page

warningMsg · string | null