Get Conversation

GET/v1/stores/{store_id}/conversations/{conversation_id}Scope conversations:read

Scope: conversations:read (scopes and plan access)
Rate limit: 600 requests/min per API key (test keys: 60/min) (rate limits)

`ApiConversation & { messages: ApiMessage[] }` (`note` messages excluded).

Parameters

Parameters of Get Conversation
Name	In	Type	Description
store_idrequired	path	string
conversation_idrequired	path	string

Example request

curl -X GET "https://api.shopassist.coec.dk/v1/stores/sto_01j8000000e008000000000000/conversations/conv_01j8000000e008000000000000" \
  -H "Authorization: Bearer $SHOPASSIST_API_KEY"

Response 200 (ApiConversationDetail)

Response of Get Conversation
Field	Type	Description
assigned_user_idrequired	string \| null	pattern `^usr_[0-9a-hjkmnp-tv-z]{26}$`
channelrequired	"widget" \| "playground" \| "preview" \| "demo" \| "api"
closed_atrequired	string \| null	format date-time
csat_scorerequired	integer \| null
handoff_requested_atrequired	string \| null	format date-time
handoff_staterequired	"none" \| "requested" \| "live" \| "delivered_offline" \| "failed" \| "resolved"
idrequired	string	pattern `^conv_[0-9a-hjkmnp-tv-z]{26}$`
identity_levelrequired	"guest" \| "order_lookup" \| "order_otp" \| "customer"
is_testrequired	boolean
last_message_atrequired	string \| null	format date-time
localerequired	string \| null
message_countrequired	integer	≥ 0
messagesrequired	ApiMessage[]
messages[].authorrequired	MessageAuthor	Who wrote a message.
messages[].author.display_namerequired	string \| null
messages[].author.typerequired	"shopper" \| "ai" \| "human" \| "system"
messages[].blocksrequired	UiBlock[]
messages[].created_atrequired	string	format date-time
messages[].idrequired	string	pattern `^msg_[0-9a-hjkmnp-tv-z]{26}$`
messages[].is_ai_generatedrequired	boolean
messages[].rolerequired	"shopper" \| "assistant" \| "agent" \| "system"
messages[].seqrequired	integer	≥ 0
messages[].textrequired	string
moderequired	"ai" \| "human_requested" \| "human"
platform_customer_idrequired	string \| null	Only for identity_level = customer
resolutionrequired	"resolved_ai" \| "handed_off" \| "abandoned" \| "unknown" \| null
shopperrequired	ShopperView	Shopper identity as shown on lists (masked for agent/viewer, 06 §5.3).
shopper.emailrequired	string \| null
shopper.is_maskedrequired	boolean
shopper.is_verifiedrequired	boolean
shopper.namerequired	string \| null
started_atrequired	string	format date-time
statusrequired	"open" \| "closed"
store_idrequired	string	pattern `^sto_[0-9a-hjkmnp-tv-z]{26}$`
tagsrequired	string[]

{
  "assigned_user_id": "usr_01j8000000e008000000000000",
  "channel": "widget",
  "closed_at": "2026-09-28T10:15:30.123Z",
  "csat_score": 1,
  "handoff_requested_at": "2026-09-28T10:15:30.123Z",
  "handoff_state": "none",
  "id": "conv_01j8000000e008000000000000",
  "identity_level": "guest",
  "is_test": true,
  "last_message_at": "2026-09-28T10:15:30.123Z",
  "locale": "da-DK",
  "message_count": 0,
  "messages": [
    {
      "author": {
        "display_name": "string",
        "type": "shopper"
      },
      "blocks": [
        {
          "as_of": "2026-09-28T10:15:30.123Z",
          "id": "b1",
          "items": [
            {
              "actions": {
                "add_to_cart": true,
                "check_store_stock": true,
                "notify_back_in_stock": false
              },
              "as_of": "2026-09-28T10:15:30.123Z",
              "availability": {
                "as_of": "2026-09-28T10:15:30.123Z",
                "label": "Only 2 left",
                "quantity": 2,
                "status": "low_stock"
              },
              "badges": [
                "New"
              ],
              "default_variant_id": "var_01j8000000e008000000000001",
              "image": {
                "alt": "City bike",
                "height": 600,
                "url": "https://cdn.shopify.com/s/files/1/demo/bike-1.jpg",
                "width": 800
              },
              "options": [
                {
                  "name": "Size",
                  "values": [
                    {
                      "is_available": true,
                      "value": "M"
                    },
                    {
                      "is_available": false,
                      "value": "L"
                    }
                  ]
                }
              ],
              "price": {
                "amount": "4999",
                "currency": "DKK",
                "display": "4.999,00 kr."
              },
              "product_id": "prd_01j8000000e008000000000001",
              "rating": {
                "average": 4.6,
                "count": 128
              },
              "subtitle": "Nordic Bikes",
              "title": "Nordic City Bike 7-speed",
              "url": "https://nordicbikes.example/products/city-bike?utm_source=shopassist&utm_medium=chat",
              "variants": [
                {
                  "availability": {
                    "as_of": "2026-09-28T10:15:30.123Z",
                    "label": "Only 2 left",
                    "quantity": 2,
                    "status": "low_stock"
                  },
                  "cart_ref": {
                    "variant_gid": "gid://shopify/ProductVariant/4711"
                  },
                  "options": {
                    "Size": "M"
                  },
                  "price": {
                    "amount": "4999",
                    "currency": "DKK",
                    "display": "4.999,00 kr."
                  },
                  "title": "M",
                  "variant_id": "var_01j8000000e008000000000001"
                }
              ]
            }
          ],
          "layout": "carousel",
          "title": "City bikes in stock",
          "type": "products"
        }
      ],
      "created_at": "2026-09-28T10:15:30.123Z",
      "id": "msg_01j8000000e008000000000000",
      "is_ai_generated": true,
      "role": "shopper",
      "seq": 0,
      "text": "string"
    }
  ],
  "mode": "ai",
  "platform_customer_id": "string",
  "resolution": "resolved_ai",
  "shopper": {
    "email": "string",
    "is_masked": true,
    "is_verified": true,
    "name": "string"
  },
  "started_at": "2026-09-28T10:15:30.123Z",
  "status": "open",
  "store_id": "sto_01j8000000e008000000000000",
  "tags": [
    "string"
  ]
}

Errors

Every error uses the error envelope; the code field is stable.

400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
422 Unprocessable Content
429 Too Many Requests