How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Spruce Health Conversations API

The Conversations API from Spruce Health — 4 operation(s) for conversations.

Spruce Health Conversations API is one of 15 APIs that Spruce Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.sprucehealth.com/v1.

6 operations 4 paths 45 schemas 3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.sprucehealth.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Spruce Health Conversations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (spruceAPIToken). By default, every request must be authenticated.

  • spruceAPIToken — API token provided by Spruce should be passed in an "Authorization" header with the value "Bearer "

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Conversations 6
GET
/conversations
List and filter all conversations available to the organization
ListConversations 4 params → 200400500
POST
/conversations
Create a new conversation
CreateConversation 1 param body → 201400500
GET
/conversations/{conversationId}
Get a conversation for a given id
Conversation 1 param → 200400404500
PATCH
/conversations/{conversationId}
Update a conversation
UpdateConversation 2 params body → 200400404422500
GET
/conversations/{conversationId}/items
List and filter all conversation items in a conversation
ConversationItems 5 params → 200400500
POST
/conversations/{conversationId}/messages
Post a message to a specific conversation
PostConversationMessage 2 params body → 200400422500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are conversationItem (18 properties), conversation (17 properties), conversationItem_PhoneCallEvent (10 properties), endpoint (7 properties). Each schema is shown below with its type and property counts.

conversation_id
string
Spruce's conversation ID
conversationItem_ImageAttachment
object
2 properties 2 required
conversationItem_Transcription
object
3 properties 2 required
conversationItems_Order
string
The order of the conversation items returned
teammate_id
string
The id of the teammate
conversation_tagId
string
Spruce's conversation tag ID
deviceInformation
object
6 properties
objectType
string
String representing the object's type
conversation
object
17 properties 10 required
conversations_orderBy
string
The order of the conversations returned
create_conversation_note
object
4 properties
conversationItem_Page
object
5 properties 3 required
error
object
3 properties 3 required
conversation_messageBodyElement
object
An element of a message body. This can be either a text or page type element. A text element is a string of text to be placed in the message. A page element is…
2 properties 2 required
paginationToken
string
Token given in a previous response to allow requesting the next page
conversation_messagePost_attachment
object
2 properties 2 required
conversationItem_id
string
The id of a conversation item.
totalCount
integer
create_conversation_secure
object
4 properties 2 required
endpoint
object
7 properties 6 required
asyncRequest_id
string
The id of an asynchronous request
initiatedBy
object
2 properties
conversation_messagePost
object
5 properties 1 required
conversationItem_Button
object
3 properties 3 required
conversationItem_Attachment
object
3 properties 2 required
conversationItem_Author
object
3 properties 1 required
conversationItem_PhoneCallEvent
object
10 properties 5 required
answeredBy
object
3 properties
conversationItem_AudioAttachment
object
3 properties 2 required
updateConversation
object
Any omitted or null field will not be updated. To clear a field, pass an empty value such as "" or []
3 properties
endpoint_id
string
The id of the endpoint. For secure (Spruce Link) endpoints, the id format depends on where the endpoint is returned: the list internal endpoints API returns th…
create_conversation_type
string
The type of conversation to create.
createConversation
object
3 properties 1 required
conversation_tagValue
string
The text value of a conversation tag
conversationItem_VideoAttachment
object
2 properties 2 required
conversation_tag
object
3 properties 3 required
conversationItem_DocumentAttachment
object
3 properties 3 required
conversation_tags
array
conversationItem_Event
object
2 properties 1 required
conversation_tagIds
array
An array of Spruce conversation tag ids
signedUrl
object
2 properties 2 required
conversationItem_VideoCallEvent
object
3 properties 3 required
hasMore
boolean
conversationItem
object
18 properties 16 required
conversationItem_EntityProfileAttachment
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spruce-health-conversations-api-openapi.yml Raw ↑

Other APIs Spruce Health publishes across the network.

Spruce Health Contact Fields API
Spruce Health Contact Tags API
Spruce Health Contacts API
Spruce Health Conversation Item API
Spruce Health Conversation Tags API
Spruce Health Internal Endpoints API
Spruce Health Media API
Spruce Health Organization API
Spruce Health Phone Lines API
Spruce Health Saved Messages API
Spruce Health Scheduled Messages API
Spruce Health Teams API
Where this information came from

This is an independent, third-party profile of Spruce Health Conversations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.