Documentation Index
Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
Use this file to discover all available pages before exploring further.
Parameters
Hide parameters
Hide parameters
ID
This field maps to the destination API conversationId field.This field maps to the destination API
startFrom field.This field maps to the destination API
order (defaults to oldest first) field.Allowed Enumeration Values
NEWEST_FIRST
OLDEST_FIRST
This field maps to the destination API
limit (defaults to 100) field.{
"$result_object_key": [
{
"api_url": "https://api.sprucehealth.com/v1/conversation-items/item_12345",
"app_url": "https://app.sprucehealth.com/conversation-items/item_12345",
"attachments": [
{
"data": {
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
},
"title": "Lab Results.pdf"
}
],
"author": {
"device_information": {
"access_id": null,
"app_version": "1.2.3",
"device": "iPhone",
"device_id": null,
"device_model": "iPhone 13",
"platform": "iOS"
},
"display_name": "Dr. Smith"
},
"buttons": [
{
"id": null,
"state": "enabled",
"text": "Confirm Appointment"
}
],
"can_delete": null,
"contact": {
"api_url": "https://api.sprucehealth.com/v1/contacts/contact_12345",
"app_url": "https://app.sprucehealth.com/contacts/contact_12345",
"can_delete": null,
"can_edit": null,
"category": "patient",
"company_name": "ACME Healthcare",
"created_at": "2023-11-13T17:42:17Z",
"custom_contact_fields": [
{
"id": "entityCustomField_0E5QDGJC03000",
"name": "Insurance Provider",
"value": "Blue Cross Blue Shield"
}
],
"date_of_birth": "1990-01-15",
"deleted_contact_ids": [
"entity_0E5QDGJC03001"
],
"display_name": "John Doe",
"email_addresses": [
{
"id": "entityContact_26RRC7PQ6JG00",
"label": "primary",
"value": "john.doe@example.com"
}
],
"fax_numbers": [
{
"display_value": "(555) 123-4567",
"id": "entityContact_26RRC7PQ6JG00",
"label": "mobile",
"value": null
}
],
"first_name": "John",
"gender": "male",
"gender_detail": null,
"has_account": null,
"has_pending_invite": null,
"id": "entity_0E5QDGJC03000",
"integration_links": [
{
"contact_id": "entity_0E5QDGJC03000",
"external_id": "ext_12345",
"integration_type": "epic",
"url": "https://hint.com/patient/100031277"
}
],
"internal_member_ids": [],
"last_name": "Doe",
"middle_name": "Smith",
"object": "contact",
"organization_contact_fields": [
{
"id": "managedCustomField_0E5QDGJC03000",
"name": "Patient ID",
"value": "PT12345"
}
],
"phone_numbers": [
{
"display_value": "(555) 123-4567",
"id": "entityContact_26RRC7PQ6JG00",
"label": "mobile",
"value": null
}
],
"pronouns": "he/him",
"tags": [
{
"id": "tag_0E5QDGJC03000",
"value": "high-priority"
}
]
},
"contact_id": "entity_0E5QDGJC03000",
"conversation_id": "conv_12345",
"created_at": "2025-01-15T13:12:41Z",
"event": {
"data": {
"answered": null,
"answered_by": {
"external_number": null,
"line_id": null,
"teammate_id": null
},
"duration": "120",
"failed": null,
"initiated_by": {
"external_number": null,
"line_id": null,
"teammate_id": null
},
"recordings": [
{
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
],
"spam": null,
"voicemail": {
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
},
"type": "inboundCall"
},
"external_participant": {
"contact": null,
"display_names": "John Doe",
"endpoint": {
"channel": "sms",
"display_value": "(555) 123-4567",
"endpoint_id": null,
"is_internal": null,
"labels": "mobile",
"object": "endpoint",
"raw_value": {
"email": "patient@example.com",
"phone": "+15551231234",
"value": "secure_channel_id"
}
}
},
"id": "item_12345",
"is_internal_note": null,
"modified_at": "2025-01-15T13:12:41Z",
"object": "conversation-item",
"pages": [
{
"id": null,
"member_id": null,
"resolved": null,
"resolved_at": "2025-10-31T08:22:10Z",
"resolved_by_member_id": null
}
],
"request_id": null,
"text": "Hello, how can I help you today?"
}
]
}
{
"$result_object_key": [
{
"api_url": "API URL for this conversation item.",
"app_url": "App URL for this conversation item.",
"attachments": {
"data": {
"mime_type": "MIME type of the attachment.",
"signed_url": {
"expires_at": "Timestamp when the signed URL expires.",
"url": "The signed URL."
}
},
"title": "Title of the attachment."
},
"author": {
"device_information": {
"access_id": "Access ID for the device.",
"app_version": "App version used.",
"device": "Device type.",
"device_id": "Unique device identifier.",
"device_model": "Device model.",
"platform": "Platform (iOS, Android, web, etc.)."
},
"display_name": "Display name of the author."
},
"buttons": {
"id": "Unique identifier for the button.",
"state": "Current state of the button.",
"text": "Text displayed on the button."
},
"can_delete": "Whether this conversation item can be deleted.",
"contact": {
"api_url": "API URL for this contact.",
"app_url": "App URL for this contact.",
"can_delete": "Whether this contact can be deleted.",
"can_edit": "Whether this contact can be edited.",
"category": "Contact category.",
"company_name": "Company name associated with the contact.",
"created_at": "Timestamp when the contact was created.",
"custom_contact_fields": {
"id": "Unique identifier for the custom field.",
"name": "Name of the custom field.",
"value": "Value of the custom field."
},
"date_of_birth": "Date of birth",
"deleted_contact_ids": "Prior contact IDs merged into this Contact (note: they are deleted post-merge)",
"display_name": "Display name for the contact.",
"email_addresses": {
"id": "Unique identifier for the email address.",
"label": "Label for the email address.",
"value": "Email address value."
},
"fax_numbers": {
"display_value": "Formatted display value for the phone number.",
"id": "Unique identifier for the phone number.",
"label": "Label for the phone number.",
"value": "Phone number value."
},
"first_name": "Given name (first name) of the contact.",
"gender": "Gender of the contact.",
"gender_detail": "Additional gender details.",
"has_account": "Whether the contact has a Spruce account.",
"has_pending_invite": "Whether the contact has a pending invitation to Spruce.",
"id": "Unique identifier for the contact in the Spruce system.",
"integration_links": {
"contact_id": "Contact ID in Spruce.",
"external_id": "External system identifier.",
"integration_type": "Type of integration.",
"url": "URL to the external system."
},
"internal_member_ids": "Internal member IDs associated with this contact.",
"last_name": "Family name (last name) of the contact.",
"middle_name": "Middle name of the contact.",
"object": "Object type identifier.",
"organization_contact_fields": {
"id": "Unique identifier for the organization field.",
"name": "Name of the organization field.",
"value": "Value of the organization field."
},
"phone_numbers": {
"display_value": "Formatted display value for the phone number.",
"id": "Unique identifier for the phone number.",
"label": "Label for the phone number.",
"value": "Phone number value."
},
"pronouns": "Preferred pronouns of the contact.",
"tags": {
"id": "Unique identifier for the tag.",
"value": "Tag value."
}
},
"contact_id": "Unique identifier for the contact in the Spruce system that is the external participant in this conversation, note: only present if the contact is present on the conversation",
"conversation_id": "ID of the conversation this item belongs to.",
"created_at": "Timestamp when the conversation item was created.",
"event": {
"data": {
"answered": "Whether the call was answered.",
"answered_by": {
"external_number": "External phone number of the party.",
"line_id": "Line ID used for the call.",
"teammate_id": "Teammate ID if this is an internal party."
},
"duration": "Duration of the call in seconds.",
"failed": "Whether the call failed.",
"initiated_by": {
"external_number": "External phone number of the party.",
"line_id": "Line ID used for the call.",
"teammate_id": "Teammate ID if this is an internal party."
},
"recordings": {
"mime_type": "MIME type of the attachment.",
"signed_url": {
"expires_at": "Timestamp when the signed URL expires.",
"url": "The signed URL."
}
},
"spam": "Whether the call was marked as spam.",
"voicemail": {
"mime_type": "MIME type of the attachment.",
"signed_url": {
"expires_at": "Timestamp when the signed URL expires.",
"url": "The signed URL."
}
}
},
"type": "The event type"
},
"external_participant": {
"contact": "Contact ID of the external participant.",
"display_names": "Display names for the external participant.",
"endpoint": {
"channel": "Communication channel type.",
"display_value": "Human-readable display value.",
"endpoint_id": "Unique identifier for the endpoint.",
"is_internal": "Whether this is an internal endpoint.",
"labels": "Labels associated with the endpoint.",
"object": "Object type identifier.",
"raw_value": {
"email": "Email address value.",
"phone": "Phone number value.",
"value": "Secure channel identifier."
}
}
},
"id": "Unique identifier for the conversation item in the Spruce system.",
"is_internal_note": "Whether this is an internal note (not visible to patients).",
"modified_at": "Timestamp when the conversation item was last modified.",
"object": "Object type identifier.",
"pages": {
"id": "Unique identifier for the page.",
"member_id": "Member ID associated with the page.",
"resolved": "Whether the page has been resolved.",
"resolved_at": "Timestamp when the page was resolved.",
"resolved_by_member_id": "Member ID who resolved the page."
},
"request_id": "Request ID associated with this conversation item.",
"text": "Text content of the conversation item."
}
]
}
Result Object Field Details
You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix$result_object_key.
Hide fields
Hide fields
ID Unique identifier for the conversation item in the Spruce system.CEL
$result_object_key[*].id
Example
"item_12345"
ID Unique identifier for the contact in the Spruce system that is the external participant in this conversation, note: only present if the contact is present on the conversationCEL
$result_object_key[*].contact_id
Example
"entity_0E5QDGJC03000"
API URL for this conversation item.
CEL
$result_object_key[*].api_url
Example
"https://api.sprucehealth.com/v1/conversation-items/item_12345"
App URL for this conversation item.
CEL
$result_object_key[*].app_url
Example
"https://app.sprucehealth.com/conversation-items/item_12345"
File attachments associated with this conversation item.
CEL
$result_object_key[*].attachments
Example
[
{
"data": {
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
},
"title": "Lab Results.pdf"
}
]
Mapped array of: Attachment data with signed URL.
CEL
$result_object_key[*].attachments.map(x, x.data)
Example
[
{
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
]
Mapped array of: Title of the attachment.
CEL
$result_object_key[*].attachments.map(x, x.title)
Example
[
"Lab Results.pdf"
]
Author of this conversation item.
CEL
$result_object_key[*].author
Example
{
"device_information": {
"access_id": null,
"app_version": "1.2.3",
"device": "iPhone",
"device_id": null,
"device_model": "iPhone 13",
"platform": "iOS"
},
"display_name": "Dr. Smith"
}
Device information of the author.
CEL
$result_object_key[*].author.device_information
Example
{
"access_id": null,
"app_version": "1.2.3",
"device": "iPhone",
"device_id": null,
"device_model": "iPhone 13",
"platform": "iOS"
}
ID Access ID for the device.CEL
$result_object_key[*].author.device_information.access_id
Example
null
App version used.
CEL
$result_object_key[*].author.device_information.app_version
Example
"1.2.3"
Device type.
CEL
$result_object_key[*].author.device_information.device
Example
"iPhone"
ID Unique device identifier.CEL
$result_object_key[*].author.device_information.device_id
Example
null
Device model.
CEL
$result_object_key[*].author.device_information.device_model
Example
"iPhone 13"
Platform (iOS, Android, web, etc.).
CEL
$result_object_key[*].author.device_information.platform
Example
"iOS"
PII Display name of the author.CEL
$result_object_key[*].author.display_name
Example
"Dr. Smith"
Interactive buttons associated with this conversation item.
CEL
$result_object_key[*].buttons
Example
[
{
"id": null,
"state": "enabled",
"text": "Confirm Appointment"
}
]
ID Mapped array of: Unique identifier for the button.CEL
$result_object_key[*].buttons.map(x, x.id)
Example
[
null
]
Mapped array of: Current state of the button.
CEL
$result_object_key[*].buttons.map(x, x.state)
Example
[
"enabled"
]
Mapped array of: Text displayed on the button.
CEL
$result_object_key[*].buttons.map(x, x.text)
Example
[
"Confirm Appointment"
]
Whether this conversation item can be deleted.
CEL
$result_object_key[*].can_delete
Example
null
ID ID of the conversation this item belongs to.CEL
$result_object_key[*].conversation_id
Example
"conv_12345"
Timestamp when the conversation item was created.
CEL
$result_object_key[*].created_at
Example
"2025-01-15T13:12:41Z"
Event data associated with this conversation item.
CEL
$result_object_key[*].event
Example
{
"data": {
"answered": null,
"answered_by": {
"external_number": null,
"line_id": null,
"teammate_id": null
},
"duration": "120",
"failed": null,
"initiated_by": {
"external_number": null,
"line_id": null,
"teammate_id": null
},
"recordings": [
{
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
],
"spam": null,
"voicemail": {
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
},
"type": "inboundCall"
}
Event-specific data.
CEL
$result_object_key[*].event.data
Example
{
"answered": null,
"answered_by": {
"external_number": null,
"line_id": null,
"teammate_id": null
},
"duration": "120",
"failed": null,
"initiated_by": {
"external_number": null,
"line_id": null,
"teammate_id": null
},
"recordings": [
{
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
],
"spam": null,
"voicemail": {
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
}
Whether the call was answered.
CEL
$result_object_key[*].event.data.answered
Example
null
Party who answered the call.
CEL
$result_object_key[*].event.data.answered_by
Example
{
"external_number": null,
"line_id": null,
"teammate_id": null
}
External phone number of the party.
CEL
$result_object_key[*].event.data.answered_by.external_number
Example
null
ID Line ID used for the call.CEL
$result_object_key[*].event.data.answered_by.line_id
Example
null
ID Teammate ID if this is an internal party.CEL
$result_object_key[*].event.data.answered_by.teammate_id
Example
null
Duration of the call in seconds.
CEL
$result_object_key[*].event.data.duration
Example
"120"
Whether the call failed.
CEL
$result_object_key[*].event.data.failed
Example
null
Party who initiated the call.
CEL
$result_object_key[*].event.data.initiated_by
Example
{
"external_number": null,
"line_id": null,
"teammate_id": null
}
External phone number of the party.
CEL
$result_object_key[*].event.data.initiated_by.external_number
Example
null
ID Line ID used for the call.CEL
$result_object_key[*].event.data.initiated_by.line_id
Example
null
ID Teammate ID if this is an internal party.CEL
$result_object_key[*].event.data.initiated_by.teammate_id
Example
null
Call recordings.
CEL
$result_object_key[*].event.data.recordings
Example
[
{
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
]
Mapped array of: MIME type of the attachment.
CEL
$result_object_key[*].event.data.recordings.map(x, x.mime_type)
Example
[
"application/pdf"
]
Mapped array of: Signed URL for accessing the attachment.
CEL
$result_object_key[*].event.data.recordings.map(x, x.signed_url)
Example
[
{
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
]
Whether the call was marked as spam.
CEL
$result_object_key[*].event.data.spam
Example
null
Voicemail attachment if present.
CEL
$result_object_key[*].event.data.voicemail
Example
{
"mime_type": "application/pdf",
"signed_url": {
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
}
MIME type of the attachment.
CEL
$result_object_key[*].event.data.voicemail.mime_type
Example
"application/pdf"
Signed URL for accessing the attachment.
CEL
$result_object_key[*].event.data.voicemail.signed_url
Example
{
"expires_at": "2026-04-05T09:40:02Z",
"url": null
}
Timestamp when the signed URL expires.
CEL
$result_object_key[*].event.data.voicemail.signed_url.expires_at
Example
"2026-04-05T09:40:02Z"
The signed URL.
CEL
$result_object_key[*].event.data.voicemail.signed_url.url
Example
null
The event type
CEL
$result_object_key[*].event.type
Example
"inboundCall"
Whether this is an internal note (not visible to patients).
CEL
$result_object_key[*].is_internal_note
Example
null
Timestamp when the conversation item was last modified.
CEL
$result_object_key[*].modified_at
Example
"2025-01-15T13:12:41Z"
Object type identifier.
CEL
$result_object_key[*].object
Example
"conversation-item"
Pages associated with this conversation item.
CEL
$result_object_key[*].pages
Example
[
{
"id": null,
"member_id": null,
"resolved": null,
"resolved_at": "2025-10-31T08:22:10Z",
"resolved_by_member_id": null
}
]
ID Mapped array of: Unique identifier for the page.CEL
$result_object_key[*].pages.map(x, x.id)
Example
[
null
]
ID Mapped array of: Member ID associated with the page.CEL
$result_object_key[*].pages.map(x, x.member_id)
Example
[
null
]
Mapped array of: Whether the page has been resolved.
CEL
$result_object_key[*].pages.map(x, x.resolved)
Example
[
null
]
Mapped array of: Timestamp when the page was resolved.
CEL
$result_object_key[*].pages.map(x, x.resolved_at)
Example
[
"2025-10-31T08:22:10Z"
]
ID Mapped array of: Member ID who resolved the page.CEL
$result_object_key[*].pages.map(x, x.resolved_by_member_id)
Example
[
null
]
ID Request ID associated with this conversation item.CEL
$result_object_key[*].request_id
Example
null
Text content of the conversation item.
CEL
$result_object_key[*].text
Example
"Hello, how can I help you today?"
The contact (for the associated contact_id) for this conversation item
CEL
$result_object_key[*].contact
Example
{
"api_url": "https://api.sprucehealth.com/v1/contacts/contact_12345",
"app_url": "https://app.sprucehealth.com/contacts/contact_12345",
"can_delete": null,
"can_edit": null,
"category": "patient",
"company_name": "ACME Healthcare",
"created_at": "2023-11-13T17:42:17Z",
"custom_contact_fields": [
{
"id": "entityCustomField_0E5QDGJC03000",
"name": "Insurance Provider",
"value": "Blue Cross Blue Shield"
}
],
"date_of_birth": "1990-01-15",
"deleted_contact_ids": [
"entity_0E5QDGJC03001"
],
"display_name": "John Doe",
"email_addresses": [
{
"id": "entityContact_26RRC7PQ6JG00",
"label": "primary",
"value": "john.doe@example.com"
}
],
"fax_numbers": [
{
"display_value": "(555) 123-4567",
"id": "entityContact_26RRC7PQ6JG00",
"label": "mobile",
"value": null
}
],
"first_name": "John",
"gender": "male",
"gender_detail": null,
"has_account": null,
"has_pending_invite": null,
"id": "entity_0E5QDGJC03000",
"integration_links": [
{
"contact_id": "entity_0E5QDGJC03000",
"external_id": "ext_12345",
"integration_type": "epic",
"url": "https://hint.com/patient/100031277"
}
],
"internal_member_ids": [],
"last_name": "Doe",
"middle_name": "Smith",
"object": "contact",
"organization_contact_fields": [
{
"id": "managedCustomField_0E5QDGJC03000",
"name": "Patient ID",
"value": "PT12345"
}
],
"phone_numbers": [
{
"display_value": "(555) 123-4567",
"id": "entityContact_26RRC7PQ6JG00",
"label": "mobile",
"value": null
}
],
"pronouns": "he/him",
"tags": [
{
"id": "tag_0E5QDGJC03000",
"value": "high-priority"
}
]
}
ID Unique identifier for the contact in the Spruce system.CEL
$result_object_key[*].contact.id
Example
"entity_0E5QDGJC03000"
API URL for this contact.
CEL
$result_object_key[*].contact.api_url
Example
"https://api.sprucehealth.com/v1/contacts/contact_12345"
App URL for this contact.
CEL
$result_object_key[*].contact.app_url
Example
"https://app.sprucehealth.com/contacts/contact_12345"
Whether this contact can be deleted.
CEL
$result_object_key[*].contact.can_delete
Example
null
Whether this contact can be edited.
CEL
$result_object_key[*].contact.can_edit
Example
null
Contact category.
CEL
$result_object_key[*].contact.category
Example
spruce.v1.ContactCategory.CONTACT_CATEGORY_PATIENT
spruce.v1.ContactCategory.CONTACT_CATEGORY_PROFESSIONAL
spruce.v1.ContactCategory.CONTACT_CATEGORY_CLINIC
PII Company name associated with the contact.CEL
$result_object_key[*].contact.company_name
Example
"ACME Healthcare"
Timestamp when the contact was created.
CEL
$result_object_key[*].contact.created_at
Example
"2023-11-13T17:42:17Z"
Custom contact fields defined by the organization.
CEL
$result_object_key[*].contact.custom_contact_fields
Example
[
{
"id": "entityCustomField_0E5QDGJC03000",
"name": "Insurance Provider",
"value": "Blue Cross Blue Shield"
}
]
ID Mapped array of: Unique identifier for the custom field.CEL
$result_object_key[*].contact.custom_contact_fields.map(x, x.id)
Example
[
"entityCustomField_0E5QDGJC03000"
]
Mapped array of: Name of the custom field.
CEL
$result_object_key[*].contact.custom_contact_fields.map(x, x.name)
Example
[
"Insurance Provider"
]
PII Mapped array of: Value of the custom field.CEL
$result_object_key[*].contact.custom_contact_fields.map(x, x.value)
Example
[
"Blue Cross Blue Shield"
]
HI Date of birthCEL
$result_object_key[*].contact.date_of_birth
Example
"1990-01-15"
PII Display name for the contact.CEL
$result_object_key[*].contact.display_name
Example
"John Doe"
Email addresses associated with the contact.
CEL
$result_object_key[*].contact.email_addresses
Example
[
{
"id": "entityContact_26RRC7PQ6JG00",
"label": "primary",
"value": "john.doe@example.com"
}
]
ID Mapped array of: Unique identifier for the email address.CEL
$result_object_key[*].contact.email_addresses.map(x, x.id)
Example
[
"entityContact_26RRC7PQ6JG00"
]
Mapped array of: Label for the email address.
CEL
$result_object_key[*].contact.email_addresses.map(x, x.label)
Example
[
"primary"
]
PII Mapped array of: Email address value.CEL
$result_object_key[*].contact.email_addresses.map(x, x.value)
Example
[
"john.doe@example.com"
]
PII Family name (last name) of the contact.CEL
$result_object_key[*].contact.last_name
Example
"Doe"
Fax numbers associated with the contact.
CEL
$result_object_key[*].contact.fax_numbers
Example
[
{
"display_value": "(555) 123-4567",
"id": "entityContact_26RRC7PQ6JG00",
"label": "mobile",
"value": null
}
]
ID Mapped array of: Unique identifier for the phone number.CEL
$result_object_key[*].contact.fax_numbers.map(x, x.id)
Example
[
"entityContact_26RRC7PQ6JG00"
]
Mapped array of: Label for the phone number.
CEL
$result_object_key[*].contact.fax_numbers.map(x, x.label)
Example
[
"mobile"
]
Mapped array of: Phone number value.
CEL
$result_object_key[*].contact.fax_numbers.map(x, x.value)
Example
[
null
]
Mapped array of: Formatted display value for the phone number.
CEL
$result_object_key[*].contact.fax_numbers.map(x, x.display_value)
Example
[
"(555) 123-4567"
]
HI Gender of the contact.CEL
$result_object_key[*].contact.gender
Example
"male"
HI Additional gender details.CEL
$result_object_key[*].contact.gender_detail
Example
null
PII Given name (first name) of the contact.CEL
$result_object_key[*].contact.first_name
Example
"John"
Whether the contact has a Spruce account.
CEL
$result_object_key[*].contact.has_account
Example
null
Whether the contact has a pending invitation to Spruce.
CEL
$result_object_key[*].contact.has_pending_invite
Example
null
Links to third-party integrations.
CEL
$result_object_key[*].contact.integration_links
Example
[
{
"contact_id": "entity_0E5QDGJC03000",
"external_id": "ext_12345",
"integration_type": "epic",
"url": "https://hint.com/patient/100031277"
}
]
ID Mapped array of: Contact ID in Spruce.CEL
$result_object_key[*].contact.integration_links.map(x, x.contact_id)
Example
[
"entity_0E5QDGJC03000"
]
ID Mapped array of: External system identifier.CEL
$result_object_key[*].contact.integration_links.map(x, x.external_id)
Example
[
"ext_12345"
]
Mapped array of: Type of integration.
CEL
$result_object_key[*].contact.integration_links.map(x, x.integration_type)
Example
[
"epic"
]
ID PII Mapped array of: URL to the external system.CEL
$result_object_key[*].contact.integration_links.map(x, x.url)
Example
[
"https://hint.com/patient/100031277"
]
ID Internal member IDs associated with this contact.CEL
$result_object_key[*].contact.internal_member_ids
Example
[]
PII Middle name of the contact.CEL
$result_object_key[*].contact.middle_name
Example
"Smith"
Object type identifier.
CEL
$result_object_key[*].contact.object
Example
"contact"
Organization-specific contact fields.
CEL
$result_object_key[*].contact.organization_contact_fields
Example
[
{
"id": "managedCustomField_0E5QDGJC03000",
"name": "Patient ID",
"value": "PT12345"
}
]
ID Mapped array of: Unique identifier for the organization field.CEL
$result_object_key[*].contact.organization_contact_fields.map(x, x.id)
Example
[
"managedCustomField_0E5QDGJC03000"
]
Mapped array of: Name of the organization field.
CEL
$result_object_key[*].contact.organization_contact_fields.map(x, x.name)
Example
[
"Patient ID"
]
ID Mapped array of: Value of the organization field.CEL
$result_object_key[*].contact.organization_contact_fields.map(x, x.value)
Example
[
"PT12345"
]
Phone numbers associated with the contact.
CEL
$result_object_key[*].contact.phone_numbers
Example
[
{
"display_value": "(555) 123-4567",
"id": "entityContact_26RRC7PQ6JG00",
"label": "mobile",
"value": null
}
]
ID Mapped array of: Unique identifier for the phone number.CEL
$result_object_key[*].contact.phone_numbers.map(x, x.id)
Example
[
"entityContact_26RRC7PQ6JG00"
]
Mapped array of: Label for the phone number.
CEL
$result_object_key[*].contact.phone_numbers.map(x, x.label)
Example
[
"mobile"
]
Mapped array of: Phone number value.
CEL
$result_object_key[*].contact.phone_numbers.map(x, x.value)
Example
[
null
]
Mapped array of: Formatted display value for the phone number.
CEL
$result_object_key[*].contact.phone_numbers.map(x, x.display_value)
Example
[
"(555) 123-4567"
]
PII Preferred pronouns of the contact.CEL
$result_object_key[*].contact.pronouns
Example
"he/him"
Tags associated with the contact.
CEL
$result_object_key[*].contact.tags
Example
[
{
"id": "tag_0E5QDGJC03000",
"value": "high-priority"
}
]
ID Mapped array of: Unique identifier for the tag.CEL
$result_object_key[*].contact.tags.map(x, x.id)
Example
[
"tag_0E5QDGJC03000"
]
Mapped array of: Tag value.
CEL
$result_object_key[*].contact.tags.map(x, x.value)
Example
[
"high-priority"
]
PII Prior contact IDs merged into this Contact (note: they are deleted post-merge)CEL
$result_object_key[*].contact.deleted_contact_ids
Example
[
"entity_0E5QDGJC03001"
]
External participant in the conversation.
CEL
$result_object_key[*].external_participant
Example
{
"contact": null,
"display_names": "John Doe",
"endpoint": {
"channel": "sms",
"display_value": "(555) 123-4567",
"endpoint_id": null,
"is_internal": null,
"labels": "mobile",
"object": "endpoint",
"raw_value": {
"email": "patient@example.com",
"phone": "+15551231234",
"value": "secure_channel_id"
}
}
}
ID Contact ID of the external participant.CEL
$result_object_key[*].external_participant.contact
Example
null
PII Display names for the external participant.CEL
$result_object_key[*].external_participant.display_names
Example
"John Doe"
Communication endpoint for the participant.
CEL
$result_object_key[*].external_participant.endpoint
Example
{
"channel": "sms",
"display_value": "(555) 123-4567",
"endpoint_id": null,
"is_internal": null,
"labels": "mobile",
"object": "endpoint",
"raw_value": {
"email": "patient@example.com",
"phone": "+15551231234",
"value": "secure_channel_id"
}
}
Communication channel type.
CEL
$result_object_key[*].external_participant.endpoint.channel
Example
"sms"
Human-readable display value.
CEL
$result_object_key[*].external_participant.endpoint.display_value
Example
"(555) 123-4567"
ID Unique identifier for the endpoint.CEL
$result_object_key[*].external_participant.endpoint.endpoint_id
Example
null
Whether this is an internal endpoint.
CEL
$result_object_key[*].external_participant.endpoint.is_internal
Example
null
Labels associated with the endpoint.
CEL
$result_object_key[*].external_participant.endpoint.labels
Example
"mobile"
Object type identifier.
CEL
$result_object_key[*].external_participant.endpoint.object
Example
"endpoint"
Raw endpoint value with type-specific data.
CEL
$result_object_key[*].external_participant.endpoint.raw_value
Example
{
"email": "patient@example.com",
"phone": "+15551231234",
"value": "secure_channel_id"
}
PII Email address value.CEL
$result_object_key[*].external_participant.endpoint.raw_value.email
Example
"patient@example.com"
PII Phone number value.CEL
$result_object_key[*].external_participant.endpoint.raw_value.phone
Example
"+15551231234"
PII Secure channel identifier.CEL
$result_object_key[*].external_participant.endpoint.raw_value.value
Example
"secure_channel_id"
