get support ticket
GET https://api.suger.cloud/org/{orgId}/support/ticket/{ticketId}
get support ticket
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
ticketId | path | string | yes | Ticket ID |
Responses
200 — OK
Content-Type: application/json · Schema: SupportTicket
SupportTicket fields:
| Field | Type | Required | Description |
|---|---|---|---|
attachments | array<SupportTicketAttachment> | no | |
closeTime | string | no | |
comments | array<SupportTicketComment> | no | |
creationTime | string | no | |
creator | string | no | |
description | string | no | |
dueTime | string | no | |
id | string | no | |
name | string | no | |
organizationId | string | no | |
priority | SupportTicketPriority | no | |
status | SupportTicketStatus | no | |
taskType | SupportTicketTaskType | no | |
watchers | array<string> | no |
SupportTicketAttachment fields:
| Field | Type | Required | Description |
|---|---|---|---|
date | string | no | |
id | string | no | |
mimetype | string | no | |
size | integer | no | |
thumbnail_large | string | no | |
thumbnail_medium | string | no | |
thumbnail_small | string | no | |
title | string | no | |
url | string | no |
SupportTicketComment fields:
| Field | Type | Required | Description |
|---|---|---|---|
comment | array<SupportTicketCommentDetail> | no | |
comment_text | string | no | When creating a new comment, only CommentText is required. |
creator | SupportTicketUser | no | |
date | string | no | |
id | string | no |
SupportTicketCommentDetail fields:
| Field | Type | Required | Description |
|---|---|---|---|
attachment | SupportTicketAttachment | no | |
frame | SupportTicketFrame | no | |
image | SupportTicketImage | no | |
text | string | no | |
type | string | no |
SupportTicketUser fields:
| Field | Type | Required | Description |
|---|---|---|---|
email | string | no | |
id | string | no | The Suger user ID. |
isSugerEmployee | boolean | no | Whether the user is a Suger employee. |
profilePicture | string | no | |
username | string | no |
SupportTicketFrame fields:
| Field | Type | Required | Description |
|---|---|---|---|
id | string | no | |
url | string | no |
SupportTicketImage fields:
| Field | Type | Required | Description |
|---|---|---|---|
extension | string | no | |
id | string | no | |
name | string | no | |
thumbnail_large | string | no | |
thumbnail_medium | string | no | |
thumbnail_small | string | no | |
title | string | no | |
type | string | no | |
url | string | no |
400 — Bad request error
Content-Type: application/json
500 — Internal server error
Content-Type: application/json
View as Markdown · Interactive API reference
Spotted something wrong or out of date on this page? Tell us and we'll correct it.