Skip to main content
GET
/
v1
/
integrations
/
engagements
/
{id}
Get an engagement
curl --request GET \
  --url https://functions.siro.ai/api-externalApi/v1/integrations/engagements/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "externalId": "<string>",
  "engagementType": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "organizationId": "<string>",
  "direction": "<string>",
  "subject": "<string>",
  "content": "<string>",
  "startTime": "<string>",
  "startTimeLocalized": "<string>",
  "endTime": "<string>",
  "recordingId": "<string>",
  "opportunityId": "<string>",
  "accountId": "<string>",
  "account": null,
  "engagementUsers": [
    null
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.siro.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
default:<organization-api-token>
required

Organization integration token from Siro admin (Person icon → API Tokens). Send Authorization: Bearer . This is not the OAuth access token used with api.siro.ai user-scoped endpoints.

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

​
startTimeLocalized
string

Localized dateTime of the engagement, without timezone info

​
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
unknown
​
engagementUsers
null[]