> ## 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 entity extractions for a recording

> Get entity extractions for a recording



## OpenAPI

````yaml get /v1/core/entities/extractions/{recordingId}
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/entities/extractions/{recordingId}:
    get:
      summary: Get entity extractions for a recording
      description: Get entity extractions for a recording
      parameters:
        - schema:
            type: string
            description: Recording ID to get entity extractions for
          required: true
          description: Recording ID to get entity extractions for
          name: recordingId
          in: path
      responses:
        '200':
          description: Get entity extractions for a recording
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    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
                  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:
  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:
        <oauth-access-token>`. Not an organization API key.
      x-default: <oauth-access-token>

````