---
title: "Retrieve an inquiry's score"
url: "https://real-estate-agency.apim.eu/apis/leads/versions/d1fa19e4-3a7d-4b6b-aac0-9ec016571b4b/operations/getInquiryScore"
---

> Full API specification: https://real-estate-agency.apim.eu/apis/leads/versions/d1fa19e4-3a7d-4b6b-aac0-9ec016571b4b.md

# Retrieve an inquiry's score

`GET` `/inquiries/{inquiryId}/score`

Operation ID: `getInquiryScore`

Shows how well the search profile and the property match - with the individual criteria, so the rating stays traceable.

## Path parameters

- `inquiryId` (string, required)

## Responses

- `200` - Score

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Leads & Inquiries
  version: 1.0.0
servers:
  - url: https://api.realestateagency.example/v1
    description: Production
  - url: https://sandbox.api.realestateagency.example/v1
    description: Sandbox
paths:
  /inquiries/{inquiryId}/score:
    parameters:
      - name: inquiryId
        in: path
        required: true
        schema:
          type: string
          example: inq_5c02
    get:
      tags:
        - Matching
      summary: Retrieve an inquiry's score
      description: |
        Shows how well the search profile and the property match - with the
        individual criteria, so the rating stays traceable.
      operationId: getInquiryScore
      responses:
        "200":
          description: Score
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Score"
              example:
                inquiry_id: inq_5c02
                points: 82
                rating: high
                criteria:
                  - criterion: purchase_price
                    met: true
                    weight: 30
                  - criterion: room_count
                    met: true
                    weight: 25
                  - criterion: location
                    met: true
                    weight: 20
                  - criterion: financing_proof
                    met: false
                    weight: 25
security:
  - apiKey: []
components:
  schemas:
    Score:
      type: object
      properties:
        inquiry_id:
          type: string
          example: inq_5c02
        lead_id:
          type: string
          example: lead_71ab
        points:
          type: integer
          minimum: 0
          maximum: 100
          example: 82
        rating:
          type: string
          enum:
            - low
            - medium
            - high
        criteria:
          type: array
          items:
            $ref: "#/components/schemas/Criterion"
    Criterion:
      type: object
      properties:
        criterion:
          type: string
          example: purchase_price
        met:
          type: boolean
          example: true
        weight:
          type: integer
          example: 30
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: |
        Every call carries an API key in the `apikey` header. You generate the
        key in the Real Estate portal under "My Apps"; it's shown exactly once.

        Each key has the scopes it's allowed to use attached to it. If one is
        missing, the API responds with `403` and `code: "scope_missing"`; the
        missing scope is in `details[].field`.
```