v1

latestOpenAPI 3.0.02026-07-2447166133.5 KB
Conversation Item

Get a conversation item for a given id

This operation fetches a specific conversation item for the provided id.

get/conversationItems/{conversationItemId}

Path parameters

conversationItemIdstring required

The id of the conversation item to retrieve

Response

Expected response to a valid request

Example response

{
  "conversationItem": {
    "apiURL": "https://api.sprucehealth.com/conversationItems/ti_0E5QDJJC03000",
    "appURL": "https://app.sprucehealth.com/org/entity_0D4QABCC06000/thread/t_0E5QDJJC03000/message/ti_23170B3D36G00",
    "attachments": [
      {
        "data": {
          "mimetype": "audio/mpeg"
        },
        "title": "example.pdf"
      }
    ],
    "author": {
      "id": "entity_0D4QABCC06000"
    },
    "canDelete": true,
    "conversation": {
      "apiURL": "https://api.sprucehealth.com/conversations/t_0E5QDJJC03000",
      "appURL": "https://app.sprucehealth.com/org/entity_0D4QABCC06000/thread/t_0E5QDJJC03000",
      "assignedToMemberId": "entity_0D4QABCC06000",
      "associatedContactIds": [
        "entity_0D4QABCC06000"
      ],
      "createdAt": "2020-04-01T00:00:00Z",
      "externalParticipants": [
        {
          "contact": "entity_0D4QABCC06000"
        }
      ],
      "id": "t_0E5QDGJC03000",
      "internalMemberIds": [
        "entity_0D4QABCC06000"
      ],
      "lastMessageAt": "2020-04-01T00:00:00Z",
      "subtitle": "Billing",
      "tags": [
        {
          "id": "tag_0E5QDGJC03000",
          "value": "Smith"
        }
      ],
      "title": "John Doe"
    },
    "conversationId": "t_0E5QDGJC03000",
    "createdAt": "2020-04-01T00:00:00Z",
    "event": {
      "data": {
        "answeredBy": {
          "teammateID": "entity_0E5QDGJC03000"
        },
        "callFlowMenuOption": "Option 2 - Hours and Locations",
        "callFlowTopLevelMenuOption": "Main Menu - Press 1 for Appointments",
        "initiatedBy": {
          "teammateID": "entity_0E5QDGJC03000"
        },
        "recordings": [
          {
            "mimetype": "audio/mpeg"
          }
        ],
        "voicemail": {
          "mimetype": "audio/mpeg"
        }
      }
    },
    "id": "ti_0D4QABCC06000",
    "modifiedAt": "2020-04-01T00:00:00Z",
    "pages": [
      {
        "memberId": "entity_0D4QABCC06000",
        "resolvedAt": "2020-04-01T00:00:00Z",
        "resolvedByMemberId": "entity_0D4QABCC06000"
      }
    ],
    "requestId": "asyncRequest_0D4QABCC06000",
    "text": "Can you look at this @Dr. Smith?"
  }
}