Skip to main content
GET
/
v1
/
core
/
recordings
/
{id}
Get recording by ID
curl --request GET \
  --url https://api.siro.ai/v1/core/recordings/{id} \
  --header 'x-siro-auth-token: <api-key>'
{
  "data": {
    "id": "<string>",
    "dateCreated": "<string>",
    "deleted": true,
    "transcriptionStatus": "RECORDING",
    "processingStatus": "in-progress",
    "processingStage": "done",
    "organizationId": "<string>",
    "teamId": "<string>",
    "userId": "<string>",
    "title": "<string>",
    "durationInMilliseconds": 123,
    "conversationType": "<string>",
    "transcriptionLanguage": "English",
    "crmOpportunities": [
      {
        "opportunityExternalId": "opp_12345",
        "accountId": "acc_67890",
        "accountName": "Acme Corporation",
        "accountExternalId": "ext_acc_12345",
        "disposition": "Closed Won",
        "closedAt": "2024-01-15T10:30:00Z",
        "name": "Q1 Software License Renewal",
        "amount": 50000,
        "integrationName": "Salesforce",
        "integrationPlatform": "salesforce",
        "addresses": [
          {
            "street": "123 Main St",
            "city": "New York",
            "state": "NY",
            "zip": "10001",
            "country": "USA"
          }
        ]
      }
    ],
    "crmCustomer": {
      "id": "acc_12345",
      "name": "Acme Corporation",
      "customerType": "ACCOUNT",
      "externalId": "ext_67890",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T08:30:00.000Z",
      "lastActivityAt": "2024-01-15T08:30:00.000Z",
      "matchingSource": "DIRECT",
      "emailAddress": "contact@acme.com",
      "phoneNumber": "+1-555-123-4567",
      "crmUrl": "https://acme.salesforce.com/lightning/r/Account/001XX000004C9Z6YAK/view",
      "organizationId": "12345"
    },
    "universalOutcomeLabel": "POSITIVE",
    "summary": "The Sales Rep offered a variety of options.",
    "entityExtractions": [
      {
        "id": "extraction_001",
        "recordingId": "recording_001",
        "siroEntityDefinitionId": "siro_entity_definition_001",
        "siroEntityDefinitionDeleted": false,
        "status": "SUCCESS",
        "extraction": [
          {
            "name": "Objection Reason",
            "value": "Financial Concerns",
            "mappings": [
              {
                "crmModelName": "Opportunity",
                "crmFieldName": "Objection_Reason__c"
              }
            ]
          }
        ],
        "createdAt": "2021-01-01T00:00:00Z",
        "updatedAt": "2021-01-01T00:00:00Z",
        "mappings": [
          {
            "crmModelName": "Opportunity",
            "crmFieldName": "Next_Steps__c"
          }
        ],
        "siroEntityDefinitionName": "Objection Reason"
      }
    ]
  },
  "cursor": "<string>",
  "pageSize": 123,
  "limit": 123,
  "total": 123,
  "hasNextPage": true
}

Authorizations

x-siro-auth-token
string
header
required

Custom authentication token for user-scoped endpoints

Path Parameters

id
string
required

ID of the recording to fetch

Query Parameters

showCrmOpportunities
string

Include CRM opportunities in the response (true/false)

showCrmCustomers
string

Include crm accounts in the response (true/false)

showSummary
string

Include recording summary in the response (true/false)

showEntityExtractions
string

Include entity extractions in the response (true/false)

Response

Get recording by ID

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