assistant

GET /v1/assistant/conversations/{conversationId}

Read one conversation with its full thread.

All assistant endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

⛔ A colleague's conversation is a `404`, never a `403` — a `403` confirms the id exists, which is itself information about what a colleague has asked.

Parameters

NameTypeRequiredWhat it is
conversationId (path)UuidYesThe conversation's id.

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestringYesThe first question, truncated, so a list of threads is readable.
escalated_ticket_idUuidYesSet once this thread became a support ticket.
created_atstringYes
updated_atstringYes
messagesAssistantMessage[]Yes
proposalsAgentProposal[]YesActions the assistant suggested in this thread. **Nothing here has happened** — a proposal is a suggestion with a confirm button, and it is applied only by `POST /v1/ai/proposal…

Errors this endpoint can return

401 · 403 · 404 · 429