Get inbox conversation

GET/api/inbox/conversations/{conversationId}

Returns one conversation and a page of messages for rendering.

Path Parameters

conversationId*string

conversation identifier.

Example"conv_123"

Query Parameters

messageLimit?|

message limit.

Example50

messageCursor?|

message cursor.

Example"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"

Response Body

`application/json`

curl -X GET "https://loading/api/inbox/conversations/conv_123"

{
  "conversation": {
    "id": "string",
    "title": "string",
    "subtitle": "string",
    "channel": "email",
    "channelLabel": "string",
    "status": "open",
    "preview": "string",
    "customerName": "string",
    "lastMessageAt": "string",
    "unreadCount": 0,
    "canReply": true,
    "components": [
      {
        "id": "string",
        "type": "object_reference",
        "title": "string",
        "subtitle": "string",
        "href": "string",
        "data": {}
      }
    ],
    "stage": "string",
    "priority": "string",
    "requestType": "string",
    "sla": "string",
    "purchaseSystem": "string",
    "purchaseReference": "string",
    "tags": [
      {
        "id": "string",
        "label": "string",
        "tone": "neutral"
      }
    ],
    "participants": [
      {
        "id": "string",
        "name": "string",
        "role": "customer",
        "email": "string",
        "phone": "string",
        "avatarUrl": "string",
        "metadata": {}
      }
    ]
  },
  "messages": {
    "items": [
      {
        "id": "string",
        "direction": "inbound",
        "kind": "message",
        "participantId": "string",
        "authorName": "string",
        "authorType": "customer",
        "text": "string",
        "markdown": "string",
        "attachments": [
          {
            "id": "string",
            "name": "string",
            "url": "string",
            "contentType": "string"
          }
        ],
        "components": [
          {
            "id": "string",
            "type": "object_reference",
            "title": "string",
            "subtitle": "string",
            "href": "string",
            "data": {}
          }
        ],
        "createdAt": "string"
      }
    ],
    "pageInfo": {
      "nextCursor": "eyJ2IjoxLCJvZmZzZXQiOjMwfQ",
      "hasNextPage": false
    }
  }
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Get inbox conversation

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`