> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get single listing details



## OpenAPI

````yaml /portal/openapi.yaml get /listing/{locationId}
openapi: 3.0.3
info:
  title: Aptly Portal API
  description: >
    HTTP API for the Aptly rental application screening portal. Used by
    prospective tenants, showing agents, and property management staff.
  version: 1.0.0
servers:
  - url: https://app.getaptly.com/api/portal
    description: Production
  - url: https://www.workturbo.net/api/portal
    description: Staging
  - url: http://localhost:3000/api/portal
    description: Development
security: []
paths:
  /listing/{locationId}:
    get:
      tags:
        - Context & Locations
      summary: Get single listing details
      operationId: get-listing-locationid
      parameters:
        - name: locationId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Location/listing object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationObject'
      security: []
components:
  schemas:
    LocationObject:
      type: object
      properties:
        _id:
          type: string
          example: loc_xyz789
        name:
          type: string
          example: The Residences at Oak Creek - Unit 204
        companyId:
          type: string
          example: org_abc123
        address:
          $ref: '#/components/schemas/Address'
        bedCount:
          type: integer
          example: 2
        bathCount:
          type: integer
          example: 1
        squareFeet:
          type: integer
          example: 950
        marketRent:
          type: string
          example: $1,500
        marketRentValue:
          type: integer
          example: 150000
        videoUrl:
          type: string
          format: uri
        virtualTourUrl:
          type: string
          format: uri
        applicationConfig:
          $ref: '#/components/schemas/ApplicationConfig'
        companyInfo:
          $ref: '#/components/schemas/CompanyInfo'
    Address:
      type: object
      properties:
        formattedAddress:
          type: string
          example: 123 Main St, Austin TX 78701
        state:
          type: string
          example: TX
        countryName:
          type: string
          example: United States
    ApplicationConfig:
      type: object
      properties:
        availableDate:
          type: string
          example: '2026-04-01'
        marketRent:
          type: string
          example: $1,500
        marketRentValue:
          type: integer
          description: Monthly rent in cents
          example: 150000
        incomeToRent:
          type: number
          example: 3
        marketingTitle:
          type: string
        marketingBlurb:
          type: string
        applicationRequirements:
          type: string
          description: HTML string
        petRestrictions:
          type: string
          description: HTML string
        leaseTerms:
          type: string
          description: HTML string
        coverPhoto:
          type: array
          items:
            type: string
            format: uri
        marketingImages:
          type: array
          items:
            type: string
            format: uri
        agent:
          type: object
          properties:
            name:
              type: string
            email:
              type: string
            phone:
              type: string
            photo:
              type: string
              format: uri
    CompanyInfo:
      type: object
      properties:
        requireBankConnect:
          type: boolean
        disableApplicantGuarantors:
          type: boolean
        disableBankScreening:
          type: boolean
        requireEmergencyContact:
          type: boolean
        applicationLock:
          type: string
          example: onClose
        enableSection8:
          type: boolean
        enableRegionalScreeningFilters:
          type: boolean
        collectPayment:
          type: boolean
        taxDocumentCount:
          type: integer
        bankStatementCount:
          type: integer
        payStubCount:
          type: integer
        toggleChatWindow:
          type: boolean

````