---
title: "Listing"
url: "https://real-estate-agency.apim.eu/apis/listing-creation/versions/ccce93aa-5880-49f4-849d-af24517f6c76/schemas/Listing"
---

> Full API specification: https://real-estate-agency.apim.eu/apis/listing-creation/versions/ccce93aa-5880-49f4-849d-af24517f6c76.md

# Listing

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Listing Creation
  version: 1.0.0
servers:
  - url: https://api.realestateagency.example/v1
    description: Production
  - url: https://sandbox.api.realestateagency.example/v1
    description: Sandbox - data is reset nightly
components:
  schemas:
    ListingStatus:
      type: string
      description: Lifecycle of a listing.
      enum:
        - in_progress
        - completed
        - published
        - withdrawn
        - failed
      example: completed
    DisclosureReport:
      type: object
      description: Result of the mandatory-disclosure check.
      properties:
        complete:
          type: boolean
          example: false
        missing:
          type: array
          items:
            $ref: "#/components/schemas/ErrorDetail"
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
          example: energy_certificate.final_energy_demand_kwh
        reason:
          type: string
          example: missing
    Listing:
      type: object
      properties:
        id:
          type: string
          example: lst_4d9b2e
        property_id:
          type: string
          example: prop_8f2c1a
        template_id:
          type: string
          example: tpl_classic
        language:
          type: string
          example: en
        status:
          $ref: "#/components/schemas/ListingStatus"
        pdf_url:
          type: string
          format: uri
          description: "Only set once `status: completed`. The link is valid for 24 hours."
          example: https://api.realestateagency.example/v1/listings/lst_4d9b2e/pdf
        pages:
          type: integer
          description: Page count of the generated document.
          example: 6
        disclosures:
          $ref: "#/components/schemas/DisclosureReport"
        created_at:
          type: string
          format: date-time
          example: 2026-08-20T09:41:12Z
        completed_at:
          type: string
          format: date-time
          nullable: true
          example: 2026-08-20T09:41:20Z
```