Tickets

Access and modify organization's Tickets

Authorization: All requests must be authenticated and authorized by adding a special Header to each request containing the Organization Key (available in https://app.xyte.io/settings/api_keys)

Value	Key
Organization Key	Authorization

GET https://hub.xyte.io/core/v1/organization/tickets

Return array of all open tickets

Headers

Name	Type	Description
Authorization	String	API_KEY

200: OK

[
  {
    "id": "b9a53d31...",
    "title": "Ticket title",
    "description": "Ticket description",
    "status": "open",
    "created_at": "2023-07-05T11:37:26Z",
    "device_id": "a3983ff2...",
    "user_name": "Demo User",
    "user_email": "[e-mail]"
  }
]

401: Unauthorized Invalid API Key

GET https://hub.xyte.io/core/v1/organization/tickets/:ticket_id

Return detailed information on a Ticket

Path Parameters

Name	Type	Description
ticket_id*	String	Unique ID of a ticket

Headers

Name	Type	Description
Authorization*	String	API_KEY

200: OK

{
  "id": "b9a53d31...",
  "title": "Ticket title ",
  "description": "Ticket description",
  "status": "resolved",
  "created_at": "2023-07-05T11:37:26Z",
  "device_id": "a3983ff2...",
  "user_name": "Demo User",
  "user_email": "[e-mail]",
  "comments": [
    {
      "id": 1,
      "text": "Cannot open door",
      "created_at": "2023-08-14T06:22:42.310Z",
      "system": false,
      "user": "Demo User",
      "owner": "Xyte Lab",
      "owner_type": "organization"
    }
  ]
}

401: Unauthorized Invalid API Key or Ticket not found

PUT https://hub.xyte.io/core/v1/organization/tickets/:ticket_id

Update ticket status

Path Parameters

Name	Type	Description
ticket_id*	String	Unique ticket ID

Headers

Name	Type	Description
Authorization*	String	API_KEY

Request Body

Name	Type	Description
title	String	New ticket title
description	String	New ticket description

200: OK

Detailed ticket information - see Get Ticket API

401: Unauthorized Invalid API Key or Ticket not found

POST https://hub.xyte.io/core/v1/organization/tickets/:ticket_id/resolved

Mark Ticket as resovled

Path Parameters

Name	Type	Description
ticket_id*	String	Unique Ticket ID

Headers

Name	Type	Description
Authorization*	String	API_KEY

200: OK

{
    "success": true
}

401: Unauthorized Invalid API Key or Ticket not found

403: Forbidden Ticket already resolved

{
  "error": "Cannot move from resolved to resolved"
}

POST https://hub.xyte.io/core/v1/organization/tickets/:ticket_id/message

Add comment to an existing Ticket

Path Parameters

Name	Type	Description
ticket_id*	String	Unique Ticket ID

Headers

Name	Type	Description
Authorization*	String	API_KEY

Request Body

Name	Type	Description
message*	String	Comment to add

200: OK

{
  "success": true
}

401: Unauthorized Invalid API Key or Ticket not found

Error Handling

• 401 Unauthorized: If the api_key is not provided or is invalid.

• 403 Forbidden: If the user does not have permission to perform the requested action.

• 422 Unprocessable Entity: If a required parameter is missing or invalid.