Spruce Health Contacts 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 Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
11 operations
across 6 paths,
and defines 101 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.
The identity and technical contract details declared by the specification.
contact_searchInviteFilter
object
2 properties
2 required
contact_organizationContactFields
array
Fields on a contact that are custom
contact_displayName
string
The contact's full name for easy display to a user. This is determined by combining the givenName, middleName, and familyName, or if those are all empty, falli…
conversation_tagId
string
Spruce's conversation tag ID
objectType
string
String representing the object's type
faxNumberInput
object
2 properties
1 required
paginationToken
string
Token given in a previous response to allow requesting the next page
contact_searchCategoryFilters
array
emailAddress
object
3 properties
2 required
contact_organizationContactFieldInput
object
2 properties
2 required
contact_searchGenderFilters
array
contact_emailAddressInputs
array
conversation_tagValue
string
The text value of a conversation tag
faxNumber
object
4 properties
3 required
createContact
object
15 properties
contact_internalMemberIds
array
The ids of the teammates, teams and/or your organization that are members of the contact. Contact Membership must be enabled for the organization for this fiel…
contact_searchEmailAddressFilters
array
contact_searchGenderFilter
object
2 properties
2 required
conversation_id
string
Spruce's conversation ID
contact_genderDetail
string
Optional free-text details for gender
contact_createContactIntegrationLink
object
3 properties
contact
object
27 properties
20 required
contact_categoryInput
string
conversation
object
17 properties
10 required
phoneNumber
object
4 properties
3 required
contact_searchPhoneNumberFilters
array
contact_emailAddresses
array
phoneNumberDisplayValue
string
The contact phone number in an easily readable format.
updateContact
object
Any omitted or null field will not be updated. To clear a field, pass an empty value such as "" or []
15 properties
contact_searchFaxNumberFilters
array
searchListMatchFilter
string
contact_tagValue
string
The text value of a contact tag
contact_companyName
string
The contact's company. This field can also be used to specify the name of a non-patient contact, such as another healthcare facility.
contact_searchTagFilter
object
2 properties
2 required
contact_tagIds
array
An array of Spruce contact tag ids
contact_searchInviteFilters
array
contact_tag
object
3 properties
3 required
contact_customContactField
object
3 properties
3 required
searchTotalCountRelation
string
The relation to use when comparing the total number of available search to the value specified in the results count field. A value of gte means that the count…
emailAddressInput
object
2 properties
1 required
contact_givenName
string
The contact's given name (typically first name in US)
phoneNumberLabel
string
A label for the phone number such as 'Work', 'Home', 'Cell', etc.
contact_organizationContactFieldInputs
array
Fields on a contact that are custom to your organization
contact_integrationLinkType
string
contact_searchAgeFilters
array
contact_searchFaxNumberFilter
object
2 properties
2 required
contact_searchTagFilters
array
contact_searchCreatedTimeFilter
object
2 properties
2 required
contact_customFieldValue
string
The value of the field
contact_searchCreatedTimeFilters
array
error
object
3 properties
3 required
contact_searchPhoneNumberFilter
object
2 properties
2 required
contact_integrationLink
object
4 properties
3 required
contact_faxNumberInputs
array
contact_phoneNumbers
array
endpoint
object
7 properties
6 required
contact_organizationContactField
object
3 properties
3 required
contact_externalId
string
The id of a contact in an external system.
contact_customContactFields
array
Fields on a contact that are custom
entityContactID
string
Spruce's phone number ID
contact_searchOrganizationContactFieldFilters
array
contact_searchNameFilter
object
2 properties
2 required
contact_searchIntegrationIDFilters
array
contact_pronouns
string
The contact's pronouns
contact_organizationContactFieldId
string
Spruce's contact organization contact custom field ID
phoneNumberValue
string
The contact phone number. An acceptable phone number is in the format 2065551234, +12065551234, (206) 555-1234, or 206-555-1234.
searchComparisonFilter
string
contact_searchAgeFilter
object
2 properties
2 required
sendInvite
object
3 properties
2 required
contact_searchIntegrationIDFilter
object
2 properties
2 required
contact_searchInviteStateFilter
string
send_invite_internalEndpointId
string
Organization's internal secure endpoint that will be used to send the invite.
contactSearch
object
2 properties
contact_searchNameFilters
array
contact_customFieldName
string
A name for the field
contact_integrationLinks
array
Links between a contact and an integrated external system.
contact_phoneNumberInputs
array
contact_searchEmailAddressFilter
object
2 properties
2 required
contact_searchStructuredFilter
object
12 properties
contact_deleteContactIntegrationLink
object
2 properties
send_invite_destinationId
string
The id of the phone number or email to send the invite to.
contact_dateOfBirth
string
The contact's date of birth in the format YYYY-MM-DD.
contact_searchCategoryFilter
object
2 properties
2 required
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…
contact_middleName
string
The contact's middle name
send_invite_customMessage
string
The message to send to the invitee.
conversation_tag
object
3 properties
3 required
contact_tagId
string
Spruce's contact tag ID
contact_searchOrganizationContactFieldFilter
object
2 properties
2 required
contact_customContactFieldId
string
Spruce's contact contact custom field ID
phoneNumberInput
object
2 properties
1 required
contact_familyName
string
The contact's family name (typically last name in US)
contact_id
string
Spruce's contact ID
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Spruce Health publishes across the network.
