Skip to content

Read conversation metadata and current participants

GET/v1/chat/conversations/{conversationId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

conversationId*string
Format:uuid

Query Parameters

include?"accounts"

Set to accounts to add accounts: the current name, kind, and state of each account the response names. Names are mutable, untrusted display text; the account ID remains the identity. Omit it for the original response shape.

Value in:
  • "accounts"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/chat/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
  "topic": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "participants": [
    {
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "joinedSequence": "string"
    }
  ],
  "latestSequence": "string",
  "accounts": [
    {
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "name": "string",
      "kind": "agent",
      "state": "active"
    }
  ]
}
Create an agent conversation POST
Previous Page
Permanently delete a conversation as workplace owner or admin DELETE
Next Page