> ## 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. # Get recording by ID > Get a single recording by ID with optional related data ## OpenAPI ````yaml specs/openapi-internalApi.json get /v1/core/recordings/{id} openapi: 3.0.0 info: version: 1.0.0 title: Swagger API servers: - url: https://api.siro.ai/ description: Siro API Gateway security: [] externalDocs: description: View the raw OpenAPI Specification in JSON format url: /swagger.json paths: /v1/core/recordings/{id}: get: summary: Get recording by ID description: Get a single recording by ID with optional related data parameters: - schema: type: string description: ID of the recording to fetch required: true description: ID of the recording to fetch name: id in: path - schema: type: string description: Include CRM opportunities in the response (true/false) required: false description: Include CRM opportunities in the response (true/false) name: showCrmOpportunities in: query - schema: type: string description: Include crm accounts in the response (true/false) required: false description: Include crm accounts in the response (true/false) name: showCrmCustomers in: query - schema: type: string description: Include recording summary in the response (true/false) required: false description: Include recording summary in the response (true/false) name: showSummary in: query - schema: type: string description: Include entity extractions in the response (true/false) required: false description: Include entity extractions in the response (true/false) name: showEntityExtractions in: query responses: '200': description: Get recording by ID content: application/json: schema: type: object properties: data: type: object properties: id: type: string description: Unique identifier for the recording. dateCreated: type: string description: When the recording was created. transcriptionStatus: type: string enum: - RECORDING - UPLOADING - UPLOADED - TRANSCRIBING - AWAITING_REDACTION - REDACTING - COMPLETE - SECONDARY_TRANSCRIPTION_COMPLETE - ERROR - UNRECOVERABLE_ERROR - REMOVED - RAW_SPLIT description: Current transcription status of the recording. processingStatus: type: string enum: - in-progress - complete - error description: Overall processing status. processingStage: type: string enum: - recording - uploading - processing - done description: >- Current stage in the recording processing pipeline (recording, uploading, processing, done) example: done organizationId: type: string description: ID of the organization associated with the recording. teamId: type: string description: ID of the team associated with the recording. userId: type: string description: ID of the user who created the recording. title: type: string description: Title of the recording. durationInMilliseconds: type: number description: Duration of the recording in milliseconds. deleted: type: boolean description: Indicates if the recording is deleted. conversationType: type: string description: Type of conversation. transcriptionLanguage: type: string enum: - English - Spanish - French description: Language used for transcription. crmOpportunities: type: array items: type: object properties: opportunityExternalId: type: string nullable: true description: >- External ID of the opportunity from the CRM system example: opp_12345 accountId: type: string nullable: true description: Internal account ID example: acc_67890 accountName: type: string nullable: true description: Name of the account or company example: Acme Corporation accountExternalId: type: string nullable: true description: External account ID from the CRM system example: ext_acc_12345 disposition: type: string nullable: true description: Current disposition or status of the opportunity example: Closed Won closedAt: type: string nullable: true description: >- Date when the opportunity was closed (ISO string) example: '2024-01-15T10:30:00Z' name: type: string nullable: true description: Name of the opportunity example: Q1 Software License Renewal amount: type: number nullable: true description: Monetary amount of the opportunity example: 50000 integrationName: type: string nullable: true description: Name of the CRM integration example: Salesforce integrationPlatform: type: string nullable: true description: Platform of the CRM integration example: salesforce addresses: type: array items: type: object properties: street: type: string description: Street address example: 123 Main St city: type: string description: City name example: New York state: type: string description: State or province example: NY zip: type: string description: ZIP or postal code example: '10001' country: type: string description: Country name example: USA description: >- Array of addresses associated with the opportunity example: - street: 123 Main St city: New York state: NY zip: '10001' country: USA required: - opportunityExternalId - accountId - accountName - accountExternalId - disposition - closedAt - name - amount - integrationName - integrationPlatform - addresses description: Array of CRM opportunities linked to this recording example: - 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: $ref: '#/components/schemas/CrmCustomer' universalOutcomeLabel: type: string nullable: true description: >- Universal outcome label mapped from the custom outcome label (POSITIVE, NEGATIVE, NEUTRAL) example: POSITIVE summary: type: string description: The LLM summary of the recording transcript example: The Sales Rep offered a variety of options. entityExtractions: type: array items: type: object properties: id: type: string format: uuid description: The ID of the entity extraction example: extraction_001 recordingId: type: string format: uuid description: The ID of the recording example: recording_001 siroEntityDefinitionId: type: string format: uuid description: The ID of the entity definition example: siro_entity_definition_001 siroEntityDefinitionName: type: string nullable: true description: The name of the entity definition example: Objection Reason siroEntityDefinitionDeleted: type: boolean description: >- Set to true if the Siro Entity Definition has been previously deleted example: false status: type: string enum: - IN_PROGRESS - SUCCESS - FAIL - SYNCED description: The status of the entity extraction example: SUCCESS extraction: type: array nullable: true items: type: object properties: name: type: string value: anyOf: - type: string - type: array items: type: string - type: string - type: number - type: boolean - nullable: true - type: array items: anyOf: - type: string - type: number - type: boolean - nullable: true - nullable: true - nullable: true mappings: type: array nullable: true items: type: object properties: crmModelName: type: string crmFieldName: type: string required: - crmModelName - crmFieldName required: - name description: >- The extracted LLM output from the entity definition with CRM mappings. example: - name: Objection Reason value: Financial Concerns mappings: - crmModelName: Opportunity crmFieldName: Objection_Reason__c createdAt: type: string nullable: true description: >- The timestamp when the entity extraction was created example: '2021-01-01T00:00:00Z' updatedAt: type: string nullable: true description: >- The timestamp when the entity extraction was last updated example: '2021-01-01T00:00:00Z' mappings: type: array nullable: true items: type: object properties: crmModelName: type: string crmFieldName: type: string required: - crmModelName - crmFieldName description: >- The CRM mapping(s) for this entity extraction (deprecated) example: - crmModelName: Opportunity crmFieldName: Next_Steps__c required: - id - recordingId - siroEntityDefinitionId - siroEntityDefinitionDeleted - status - extraction - createdAt - updatedAt - mappings description: LLM Entity Extractions for the recording required: - id - dateCreated - deleted cursor: anyOf: - type: string - type: number - nullable: true pageSize: type: number limit: type: number total: type: number nullable: true hasNextPage: type: boolean required: - data '400': description: Bad Request - Invalid parameters content: application/json: schema: type: object properties: error: type: string description: Error message required: - error '401': description: Unauthorized - User not authenticated content: application/json: schema: type: object properties: error: type: string description: Authentication error message required: - error '403': description: Forbidden - User does not have access content: application/json: schema: type: object properties: error: type: string description: Authorization error message required: - error '404': description: Not Found - Resource not found content: application/json: schema: type: object properties: error: type: string description: Resource not found error message required: - error '422': description: Unprocessable Content - The request failed validation checks content: application/json: schema: type: object properties: issues: type: array items: type: object properties: code: type: string expected: type: string received: type: string path: type: array items: anyOf: - type: string - type: number message: type: string required: - code - path - message name: type: string enum: - ZodError required: - issues - name '500': description: Internal Server Error content: application/json: schema: type: object properties: error: type: string description: Internal server error message required: - error security: - SiroAuthToken: [] components: schemas: CrmCustomer: type: object properties: id: type: string description: Customer ID name: type: string nullable: true description: Customer name crmUrl: type: string description: URL to this customer in the linked CRM customerType: type: string enum: - ACCOUNT - LEAD - OPPORTUNITY - ENGAGEMENT - CONTACT lastActivityAt: type: string nullable: true description: Last activity date createdAt: type: string format: date-time description: Date the Customer record was created in Siro updatedAt: type: string format: date-time description: Date the Customer record was last updated in Siro closedAt: type: string nullable: true format: date-time description: Date the Customer was closed (applicable to Opportunities) emailAddress: type: string nullable: true description: Customer email addresses phoneNumber: type: string nullable: true description: Customer phone numbers externalId: type: string nullable: true description: Customer external ID amount: type: number nullable: true description: Dollar amount associated with a Customer deal disposition: type: string nullable: true description: 'Disposition for the Customer deal: "WON" | "LOST" | "OPEN"' recordingId: type: string nullable: true description: ID of the most recent recording linked to this customer lastRecordingDate: type: string nullable: true format: date-time description: Datetime of the most recent recording linked to this customer numRecordings: type: number nullable: true description: Total number of recordings linked to this customer matchingSource: type: string nullable: true enum: - DIRECT - FUZZY - NOT_FOUND description: Source of matching accountId: type: string nullable: true description: Account ID opportunityAccountName: type: string nullable: true description: Account Name associated with the Opportunity contactId: type: string nullable: true description: Contact ID opportunityContactName: type: string nullable: true description: Contact Name associated with the Opportunity opportunityId: type: string nullable: true description: Opportunity ID engagementId: type: string nullable: true description: Engagement ID opportunity: type: object nullable: true properties: id: type: string externalId: type: string description: >- The ID of the opportunity in the external system (e.g. Salesforce) name: type: string nullable: true description: The name of the opportunity amount: type: number description: The dollar amount of the opportunity closedAt: type: string description: The closure date of the opportunity disposition: type: string description: '"WON" | "LOST" | "OPEN"' createdAt: type: string description: The date the opportunity was created updatedAt: type: string description: The date the opportunity was last updated recordingId: type: string description: The ID of the recording associated to the opportunity accountId: type: string organizationId: type: string account: nullable: true opportunityUsers: type: array items: nullable: true required: - id - externalId - createdAt - updatedAt - organizationId description: Opportunity opportunities: type: object nullable: true properties: data: type: array items: type: object properties: id: type: string externalId: type: string description: >- The ID of the opportunity in the external system (e.g. Salesforce) name: type: string nullable: true description: The name of the opportunity amount: type: number description: The dollar amount of the opportunity closedAt: type: string description: The closure date of the opportunity disposition: type: string description: '"WON" | "LOST" | "OPEN"' createdAt: type: string description: The date the opportunity was created updatedAt: type: string description: The date the opportunity was last updated recordingId: type: string description: The ID of the recording associated to the opportunity accountId: type: string organizationId: type: string account: nullable: true opportunityUsers: type: array items: nullable: true required: - id - externalId - createdAt - updatedAt - organizationId cursor: type: string nullable: true required: - data description: >- Optional first page of related opportunities for Accounts or Contacts opportunityUsers: type: array nullable: true items: nullable: true description: Users associated with the opportunity contactAccount: type: object nullable: true properties: id: type: string name: type: string nullable: true description: The name of the account externalId: type: string nullable: true description: The ID of the account in the external system (e.g. Salesforce) required: - id description: Contact Account address: type: string nullable: true description: Address organizationId: type: string description: Organization ID integrationConnectionId: type: string nullable: true description: Integration Connection ID integrationPlatform: type: string nullable: true enum: - MERGE - SIRO_CUSTOM_INPUT - SERVICE_TITAN - COMPANY_CAM - INGAGE - LEAD_PERFECTION - SPOTIO description: Integration Platform integrationName: type: string nullable: true description: Integration Name required: - id - createdAt - updatedAt - organizationId description: CRM account linked to this recording example: 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' securitySchemes: SiroAuthToken: type: apiKey in: header name: x-siro-auth-token description: >- OAuth access token for user-scoped requests (Authorization Code or machine-to-machine). Send header `x-siro-auth-token: `. Not an organization API key. x-default: ````