authenticated

engagements

Read Engagement

get/engagements/{engagement_id}

Request

Base URL
https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-key
- or HTTP bearer

Path parameters

engagement_idstring required

Headers

organization-idstring nullable

x-user-idstring nullable

timezonestring

x-actor-emailstring nullable

x-request-sourcestring nullable

x-operation-idstring nullable

x-commit-messagestring nullable

x-confirmation-idstring nullable

x-chat-idstring nullable

Response

Successful Response

engagement_idstring required

created_atstring date-time required

type'contact' | 'training' | 'ask_jenny' | 'slack' required

is_ai_allowed_to_respondboolean required

organization_idstring required

sourcestring nullable

manually_booked_atstring date-time nullable

manually_booked_by_user_idstring nullable

hidden_atstring date-time nullable

hidden_by_user_idstring nullable

has_agent_bookingboolean

booking_status'booked' | 'requested' | 'none'

The engagement's booking outcome. requested is an agent booking request the office has not turned into a booking — an outcome of its own, not a booking.

agent_v2_idstring nullable

agent_v2_namestring nullable

agent_v2_voice_enabledboolean nullable

agent_roster_keystring nullable

objective_stateobject nullable

override_agent_pausedboolean

turn_numberinteger nullable

metadataobject nullable

escalation_status'open' | 'claimed' | 'resolved' | 'under_control' required

Rollup of an engagement's escalations. Adds under_control (no escalations) on top of the per-escalation open/claimed/resolved states.

waiting_sincestring date-time nullable

escalation_reasonstring nullable

escalation_summarystring nullable

escalation_idstring nullable

pending_customer_message_countinteger

call_duration_secondsinteger nullable

lsa_account_namestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.