Read Engagements

get/engagements

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

Query parameters

statusstring nullable

bookedboolean nullable

booking_statusEngagementBookingStatus[] nullable

resolvedboolean nullable

escalation_statusEngagementEscalationStatus[] nullable

hiddenboolean nullable

ai_pausedboolean nullable

needs_replyboolean nullable

additionally_include_bookedboolean

additionally_include_resolvedboolean

needs_attentionboolean nullable

agent_idstring nullable

agent_v2_idstring nullable

agent_idsstring[] nullable

agent_v2_idsstring[] nullable

campaign_idstring nullable

is_simulatedboolean nullable

sourcestring nullable

created_afterstring date-time nullable

created_beforestring date-time nullable

escalated_afterstring date-time nullable

conversation_kind'customers' | 'ask_jenny' nullable

group_by_customerboolean

sortstring

cursorstring nullable

include_totalboolean

organization_idsstring[] nullable

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

totalinteger nullable