Conversations

List and filter all conversation items in a conversation

Changed on

This operation lists all conversations items available in a conversation. This is an eventually consistent view and may take a short time before new conversation items appear in results.

get/conversations/{conversationId}/items

Request

  • Base URL
    https://api.sprucehealth.com/v1
  • Auth
    HTTP bearer

Path parameters

conversationIdstring required

The id of the conversation to list items for

Query parameters

pageSizeinteger

How many conversation items to return at one time (max 200)

order'newest_first' | 'oldest_first'

The order of the conversation items returned

Example:newest_first

The order in which conversation items are returned.

paginationTokenstring

Token given in a previous response to allow requesting the next page

Example:abcdefghijklmnop
startFromstring date-time
Example:2020-04-01T00:00:00Z

The created time after which to query for new items in a conversation.

Response

Expected response to a valid request

hasMoreboolean required
paginationTokenstring

Token given in a previous response to allow requesting the next page

totalCountinteger required

Example response

{
  "conversationItems": [
    {
      "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"
      },
      "bulkRequestId": "batchJob_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?"
    }
  ],
  "paginationToken": "abcdefghijklmnop",
  "totalCount": 750
}

Changes

    • info

      added the optional property // to the response with the status