API: Support
Generated from the API's OpenAPI schema. Paths are relative to https://cloud.tebibhost.com. Authentication, errors, pagination and idempotency are on the API overview.
GET/api/v1/orgs/{organization_id}/support/tickets
List Tickets (listTickets)
IAM action: support:ListTickets
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
status | query | "active" | "closed" | "all" | |
limit | query | integer (nullable) | |
cursor | query | string (nullable) |
Responses
200OK (Page_TicketOut_)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of Page_TicketOut_
| Field | Type | Description |
|---|---|---|
items | array of TicketOut | |
next_cursor | string (nullable) |
POST/api/v1/orgs/{organization_id}/support/tickets
Create Ticket (createTicket)
IAM action: support:CreateTicket
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string |
Request body (JSON, TicketIn)
| Field | Type | Description |
|---|---|---|
attachments | array of TicketAttachmentIn | |
body required | string | |
category required | "billing" | "technical" | "abuse" | "account" | "other" | |
project_id | string (nullable) | |
severity | "low" | "normal" | "high" | "urgent" | Default: "normal". |
subject required | string |
Responses
201Created (TicketDetailOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of TicketDetailOut
| Field | Type | Description |
|---|---|---|
category | string | |
closed_at | string (date-time) (nullable) | |
created_at | string (date-time) | |
id | string | |
last_customer_message_at | string (date-time) (nullable) | |
last_staff_message_at | string (date-time) (nullable) | |
message_count | integer | |
messages | array of TicketMessageOut | |
opened_by | string | |
project_id | string (nullable) | |
resolved_at | string (date-time) (nullable) | |
severity | string | |
status | string | |
subject | string | |
trn | string | |
updated_at | string (date-time) |
GET/api/v1/orgs/{organization_id}/support/tickets/{ticket_id}
Get Ticket (getTicket)
IAM action: support:GetTicket
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
ticket_id required | path | string |
Responses
200OK (TicketDetailOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of TicketDetailOut
| Field | Type | Description |
|---|---|---|
category | string | |
closed_at | string (date-time) (nullable) | |
created_at | string (date-time) | |
id | string | |
last_customer_message_at | string (date-time) (nullable) | |
last_staff_message_at | string (date-time) (nullable) | |
message_count | integer | |
messages | array of TicketMessageOut | |
opened_by | string | |
project_id | string (nullable) | |
resolved_at | string (date-time) (nullable) | |
severity | string | |
status | string | |
subject | string | |
trn | string | |
updated_at | string (date-time) |
GET/api/v1/orgs/{organization_id}/support/tickets/{ticket_id}/attachments/{attachment_id}/content
Get Ticket Attachment Content (getTicketAttachmentContent)
IAM action: support:GetTicketAttachment
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
ticket_id required | path | string | |
attachment_id required | path | string |
Responses
200The file, as a download (application/octet-stream)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
POST/api/v1/orgs/{organization_id}/support/tickets/{ticket_id}/close
Close Ticket (closeTicket)
IAM action: support:CloseTicket
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
ticket_id required | path | string |
Responses
200OK (TicketOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of TicketOut
| Field | Type | Description |
|---|---|---|
category | string | |
closed_at | string (date-time) (nullable) | |
created_at | string (date-time) | |
id | string | |
last_customer_message_at | string (date-time) (nullable) | |
last_staff_message_at | string (date-time) (nullable) | |
message_count | integer | |
opened_by | string | |
project_id | string (nullable) | |
resolved_at | string (date-time) (nullable) | |
severity | string | |
status | string | |
subject | string | |
trn | string | |
updated_at | string (date-time) |
POST/api/v1/orgs/{organization_id}/support/tickets/{ticket_id}/messages
Reply Ticket (replyTicket)
IAM action: support:ReplyTicket
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
ticket_id required | path | string |
Request body (JSON, TicketReplyIn)
| Field | Type | Description |
|---|---|---|
attachments | array of TicketAttachmentIn | |
body required | string |
Responses
201Created (TicketMessageOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of TicketMessageOut
| Field | Type | Description |
|---|---|---|
attachments | array of TicketAttachmentOut | |
author_kind | "customer" | "staff" | "system" | |
author_name | string | |
body | string | |
created_at | string (date-time) | |
id | string |