support

GET /v1/tickets/{ticketId}

Get a support ticket and its thread.

すべての support エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには tickets.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/tickets/{ticketId} \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

One ticket in scope with its full message thread in chronological order. Staff-internal notes are **not** included — they are excluded by the query and never reach this surface. Requires `tickets.view`.

パラメータ

名前タイプ必須これがその内容です
ticketId (path)UuidはいThe ticket's id.

返信

名前タイプ必須これがその内容です
idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
subjectstringはい
statusTicketStatusはいWhere a ticket sits in its lifecycle. `open` = waiting on us; `pending` = waiting on the customer; `solved` = we believe it is resolved and a customer reply reopens it; `closed`…
priorityTicketPriorityはいHow urgent the ticket is. The customer may propose one; staff decide.
channelstringはいHow the ticket reached us — `dashboard`, `api` or `staff`. Server-decided; an open string so a future channel is additive on both sides.
site_idobjectいいえ
invoice_idobjectいいえ
on_behalf_of_org_idobjectいいえThe **client org** a reseller opened this ticket about. Null on every ordinary ticket. ⛔ Validated as a descendant of the ticket's own org and `404`d otherwise, so it can never…
assignee_nameobjectはいThe owning agent's display name (first name), or null while unassigned. The customer sees a **name** so they know a person owns their ticket; the agent's id and email are staff-…
first_response_atobjectいいえ
resolved_atobjectいいえ
closed_atobjectいいえ
last_message_atobjectいいえ
reopened_countintegerはい
message_countintegerはいCustomer-visible messages in the thread — internal notes are not counted.
created_atstringはい
updated_atstringはい
messagesTicketMessage[]はいThe customer-visible thread in chronological order.

このエンドポイントが返すエラー

401 · 403 · 404 · 429