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

# Read Plan

> Gets a record from the Plan table based on passed parameters and implicit access controls.



## OpenAPI

````yaml https://perch-api-docs.s3.ca-central-1.amazonaws.com/perch-realtor.spec.json get /plans/{id}
openapi: 3.1.0
info:
  title: Perch Realtor Web API
  version: v1
  contact:
    name: API Support
    url: https://myperch.io
    email: support@myperch.io
  description: This is the API used by the Perch Realtor portal.
servers:
  - description: DIT
    url: https://api.realtor.dit.myperch.io/v1
  - description: Production
    url: https://api.realtor.myperch.io/v1
security:
  - x-api-key: []
tags:
  - name: Lead
    description: Operations involving Lead
  - name: Plan
    description: Operations involving Plan
paths:
  /plans/{id}:
    get:
      tags:
        - Plan
      summary: Read Plan
      description: >-
        Gets a record from the Plan table based on passed parameters and
        implicit access controls.
      operationId: get-plan
      parameters:
        - in: path
          name: id
          description: The id of the record to retrieve.
          required: true
          schema:
            type: string
            example: abc123
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Plan'
                example:
                  data:
                    id: fYkmNRnW
                    createdAt: '2026-03-05T19:39:17.761Z'
                    updatedAt: '2026-03-05T19:39:17.783Z'
                    type: Buying
                    name: Buying Plan
                    status: New
                    inactiveAt: null
        '404':
          description: No record found with the given id and user access controls.
components:
  schemas:
    Plan:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the record
          example: fYkmNRnW
        createdAt:
          type: string
          format: date-time
          description: Date and time the record was created
          example: '2026-03-05T19:39:17.761Z'
        updatedAt:
          type: string
          format: date-time
          description: Date and time the record was last updated
          example: '2026-03-05T19:39:17.783Z'
        type:
          type: string
          description: The purpose of the plan
          enum:
            - Switching
            - Renewing
            - Refinancing
            - Buying
            - Selling
          example: Buying
        name:
          type:
            - string
            - 'null'
          description: Name of the plan to facilitate identification
          example: Buying Plan
        status:
          type: string
          description: The status of the plan
          enum:
            - New
            - Profiles Completed
            - Ready for Pre-approval
            - Pre-approved
            - Application in Progress
            - Lender Approved
            - Ready to Fund
            - Completed
          example: New
        inactiveAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Date the plan went inactive.
      required:
        - id
        - createdAt
        - updatedAt
        - type
        - status
  securitySchemes:
    x-api-key:
      name: x-api-key
      type: apiKey
      in: header

````