GET
/
v1
/
integrations
/
engagements
/
{id}
Get an engagement
curl --request GET \
  --url https://us-central1-siro-prod.cloudfunctions.net/api-externalApi/v1/integrations/engagements/{id}
{
  "id": "<string>",
  "externalId": "<string>",
  "engagementType": "<string>",
  "direction": "<string>",
  "subject": "<string>",
  "content": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "recordingId": "<string>",
  "opportunityId": "<string>",
  "accountId": "<string>",
  "organizationId": "<string>",
  "account": "<any>",
  "engagementUsers": [
    "<any>"
  ]
}

Path Parameters

id
string
required

Response

200 - application/json

Get an engagement

id
string
required
externalId
string
required

The ID of the engagement in the external system (e.g. Salesforce)

engagementType
string
required

The type of the engagement

createdAt
string
required

The date the engagement was created

updatedAt
string
required

The date the engagement was last updated

organizationId
string
required
direction
string

"INBOUND" | "OUTBOUND"

subject
string

The subject of the engagement

content
string

The content of the engagement

startTime
string

The start time of the engagement

endTime
string

The end time of the engagement

recordingId
string

The ID of the recording associated to the engagement

opportunityId
string

The ID of the opportunity associated to the engagement

accountId
string
account
any
engagementUsers
(any | null)[]