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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string
recordingId
string
externalId
string

Response

200 - application/json

Get engagements

data
object[]
required
cursor
pageSize
number
limit
number
total
number | null
hasNextPage
boolean