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

# Get required fields for a facility

> Returns the required fields derived from the facility's rental flow configuration (org-specific, or the system default when the org has none). Each field carries its isSystemRequired flag: true means it blocks lease generation, false means it is org-required only.



## OpenAPI

````yaml /openapi/shopping-openapi.json get /shopping/{portfolio}/v1/facilities/{facilityUuid}/required-fields
openapi: 3.0.0
info:
  title: Monument Shopping API
  description: Monument Shopping API
  version: '1.0'
  contact: {}
servers:
  - url: https://public-api.prd.monument.io
    description: Production
  - url: https://public-api.stg.monument.io
    description: Staging
security: []
tags:
  - name: Facilities
    description: Facility listing, details, and configuration
  - name: Leads
    description: Lead creation, updates, status, and pre-existing tenant validation
  - name: Shopping Cart
    description: Cart operations and access plans
  - name: Unit Groups
    description: Unit group details and taxes
  - name: Units
    description: Unit and gate access code retrieval
  - name: Payments
    description: Payment profiles and processor information
  - name: Brands
    description: Branding configuration and brand-scoped facilities
  - name: Coverages
    description: Coverage options and private coverage info
  - name: Leases
    description: Lease signing redirects
  - name: Organizations
    description: Portfolio organization information
  - name: Lead Marketing Sources
    description: Marketing source listing
paths:
  /shopping/{portfolio}/v1/facilities/{facilityUuid}/required-fields:
    get:
      tags:
        - Facilities
        - Leads
      summary: Get required fields for a facility
      description: >-
        Returns the required fields derived from the facility's rental flow
        configuration (org-specific, or the system default when the org has
        none). Each field carries its isSystemRequired flag: true means it
        blocks lease generation, false means it is org-required only.
      operationId: PublicApiFacilitiesController_getRequiredFields
      parameters:
        - name: facilityUuid
          required: true
          in: path
          schema:
            type: string
        - in: header
          required: true
          name: x-api-key
          schema:
            example: monument-2230012-2312321
            description: >-
              Api key required to authenticate your request. Please reach out to
              monument for a key.
        - in: path
          required: true
          name: portfolio
          schema:
            example: abc_selfstorage
      responses:
        '200':
          description: Array of required fields for the facility
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RequiredFieldResponseDto'
components:
  schemas:
    RequiredFieldResponseDto:
      type: object
      properties:
        fieldId:
          type: string
          example: person-date-of-birth
          description: Unique identifier of the field in the rental flow configuration.
        title:
          type: string
          example: Date of Birth
          description: Human-readable title of the field.
        apiKey:
          type: string
          example: person.dateOfBirth
          description: API key (dot-notation path) the field maps to.
        group:
          type: string
          example: Contact Information
          description: Title of the group the field belongs to.
        isSystemRequired:
          type: boolean
          example: false
          description: >-
            True when the field is system-required (blocks lease generation).
            False when the field is org-required only.
        isRequired:
          type: boolean
          example: true
          description: >-
            True when the field is required by the org configuration (isRequired
            in the rental flow configuration).
      required:
        - fieldId
        - title
        - apiKey
        - group
        - isSystemRequired
        - isRequired

````