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

# List Loans

> Requires `loans: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).



## OpenAPI

````yaml /openapi/mortgage-crm.json get /loans
openapi: 3.1.2
info:
  title: Universal Mortgage CRM API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://mortgage-crm.universal.rollout.com/api
security: []
paths:
  /loans:
    get:
      tags:
        - Loans
      summary: List Loans
      description: >-
        Requires `loans: true` in the credential's `entitiesToSync` selection
        and a connector that supports this operation. [Choose what data to
        sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout),
        or [fix an entity that is not configured to
        sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).
      operationId: getLoans
      parameters:
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - id
              - created
              - updated
        - name: id
          in: query
          required: false
          schema:
            type: string
        - name: personId
          in: query
          required: false
          schema:
            description: Only the records of this person, by its Rollout ID.
            type: string
        - name: userId
          in: query
          required: false
          schema:
            type: string
        - name: status
          in: query
          required: false
          schema:
            type: string
        - name: loanFolder
          in: query
          required: false
          schema:
            type: string
        - name: archived
          in: query
          required: false
          schema:
            type: boolean
        - name: rolloutUpdated.gte
          in: query
          required: false
          schema:
            type: string
        - name: rolloutUpdated.lte
          in: query
          required: false
          schema:
            type: string
        - name: next
          in: query
          required: false
          schema:
            type: string
            description: >-
              Cursor of the page to return, from the previous page's
              `_metadata.next`. Can't be combined with `offset`.
        - name: offset
          in: query
          required: false
          schema:
            type: number
            description: >-
              Number of records to skip, for offset paging. Defaults to 0. Can't
              be combined with `next`.
        - name: limit
          in: query
          required: false
          schema:
            default: 10
            description: Records per page, capped at 100.
            type: number
        - name: fields
          in: query
          required: false
          schema:
            type: string
            description: >-
              Comma-separated top-level fields to return; the parameter can also
              be repeated, once per field. `id` is always returned. Omit it, or
              pass `allFields`, to get every field, including `original`.
              Unknown names return 400.
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    type: object
                    properties:
                      collection:
                        type: string
                        const: loans
                        description: The key of this response that holds the records.
                      offset:
                        type: number
                        description: >-
                          Number of records skipped before this page: the
                          `offset` requested, or 0 on a cursor page.
                      limit:
                        type: number
                        description: >-
                          Page size applied: the `limit` requested, capped at
                          100, or 10 by default.
                      total:
                        type: number
                        description: >-
                          Number of records matching the request, across all
                          pages.
                      next:
                        description: >-
                          Cursor of the next page, to pass as `next`; null on
                          the last page.
                        type:
                          - string
                          - 'null'
                      nextLink:
                        description: >-
                          URL of the next page, this request's with `next` set;
                          null on the last page.
                        type:
                          - string
                          - 'null'
                    required:
                      - collection
                      - offset
                      - limit
                      - total
                      - next
                      - nextLink
                    description: How this page relates to the whole collection.
                  loans:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            Rollout's stable universal id for this loan. Use
                            this to reference the loan in the Rollout API.
                        loanNumber:
                          description: >-
                            The human-facing loan number assigned by the source
                            system, or null if it doesn't assign one. This is
                            distinct from the source's internal record id (see
                            originalIds) and from any source-specific GUID
                            (available on `original`). Present unless the
                            request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        interestRate:
                          description: >-
                            The note rate in percent (e.g. 6.5), or null if
                            unknown. Present unless the request's `fields`
                            leaves it out.
                          type:
                            - number
                            - 'null'
                        amount:
                          description: >-
                            The loan amount, or null if unknown. Present unless
                            the request's `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        term:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        loanToValue:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        type:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        purpose:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        status:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        statusDate:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        applicationDate:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        closingDate:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        fundingDate:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        rateAndTerms:
                          description: Present unless the request's `fields` leaves it out.
                          type: object
                          properties:
                            monthlyPayment:
                              type: number
                            escrowIncluded:
                              type: boolean
                            pmiRequired:
                              type: boolean
                            pmiRate:
                              type: number
                        originalIds:
                          description: >-
                            The source system's own identifiers for this loan,
                            keyed by original entity name (e.g. { loan:
                            "17102475" } is the source's internal loan record
                            id). This is NOT the human loan number (see
                            loanNumber). Present unless the request's `fields`
                            leaves it out.
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type:
                              - number
                              - string
                        original:
                          description: Present unless the request's `fields` leaves it out.
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties: {}
                        created:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        updated:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        userParticipantIds:
                          description: >-
                            The universal ids of the loan team's users.
                            Deprecated: use userParticipants, which also gives
                            each user's role. Present unless the request's
                            `fields` leaves it out.
                          type: array
                          items:
                            type: string
                        userParticipants:
                          description: >-
                            The loan team's users and their roles on the loan
                            (e.g. loan_officer, loan_processor). Present unless
                            the request's `fields` leaves it out.
                          type: array
                          items:
                            type: object
                            properties:
                              userId:
                                type: string
                              roles:
                                type: array
                                items:
                                  type: string
                            required:
                              - userId
                              - roles
                        borrowerParticipantIds:
                          description: >-
                            The universal ids of the loan's borrowers: LOS
                            application records, served on the LOS category.
                            Present unless the request's `fields` leaves it out.
                          type: array
                          items:
                            type: string
                        peopleParticipants:
                          description: >-
                            The people on the loan and their roles (e.g.
                            borrower, coborrower, buyers_agent). A mortgage
                            CRM's borrowers are people, not borrower records.
                            Present unless the request's `fields` leaves it out.
                          type: array
                          items:
                            type: object
                            properties:
                              personId:
                                type: string
                              roles:
                                type: array
                                items:
                                  type: string
                            required:
                              - personId
                              - roles
                        stage:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        stageHistory:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - array
                            - 'null'
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              status:
                                type: string
                              scheduledStartDate:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                              actualStartDate:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                              completedDate:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                              plannedDurationDays:
                                type:
                                  - number
                                  - 'null'
                              actualDurationDays:
                                type:
                                  - number
                                  - 'null'
                              assignee:
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type:
                                      - string
                                      - 'null'
                                  name:
                                    type:
                                      - string
                                      - 'null'
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                  phone:
                                    type:
                                      - string
                                      - 'null'
                                  role:
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - name
                                  - email
                                  - phone
                                  - role
                              requiresReview:
                                type:
                                  - boolean
                                  - 'null'
                              isReviewed:
                                type:
                                  - boolean
                                  - 'null'
                              order:
                                type:
                                  - number
                                  - 'null'
                              isRequired:
                                type:
                                  - boolean
                                  - 'null'
                              notes:
                                type: string
                              metadata:
                                anyOf:
                                  - {}
                                  - type: 'null'
                            required:
                              - id
                              - name
                              - status
                        loanFolder:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        archived:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - boolean
                            - 'null'
                        mortgageType:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        lienType:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        amortizationType:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        armInitialPeriodMonths:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        armSubsequentPeriodMonths:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        expectedRentalIncome:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        expectedNetRentalIncome:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        communityProperty:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - boolean
                            - 'null'
                        transactionDetail:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        refinanceType:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        refinanceProgram:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        energyImprovement:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        projectType:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                        proposedMonthlyPayment:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - object
                            - 'null'
                          properties:
                            firstMortgagePI:
                              type:
                                - number
                                - 'null'
                            subordinatePI:
                              type:
                                - number
                                - 'null'
                            homeownersInsurance:
                              type:
                                - number
                                - 'null'
                            supplementalInsurance:
                              type:
                                - number
                                - 'null'
                            propertyTaxes:
                              type:
                                - number
                                - 'null'
                            mortgageInsurance:
                              type:
                                - number
                                - 'null'
                            associationDues:
                              type:
                                - number
                                - 'null'
                            other:
                              type:
                                - number
                                - 'null'
                            total:
                              type:
                                - number
                                - 'null'
                        loanFeatures:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - object
                            - 'null'
                          properties:
                            balloon:
                              type:
                                - boolean
                                - 'null'
                            interestOnly:
                              type:
                                - boolean
                                - 'null'
                            negativeAmortization:
                              type:
                                - boolean
                                - 'null'
                            prepaymentPenalty:
                              type:
                                - boolean
                                - 'null'
                            temporaryBuydown:
                              type:
                                - boolean
                                - 'null'
                            other:
                              type:
                                - string
                                - 'null'
                        qualifyingFunds:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - object
                            - 'null'
                          properties:
                            dueFromBorrower:
                              type:
                                - number
                                - 'null'
                            totalMortgageLoans:
                              type:
                                - number
                                - 'null'
                            totalCredits:
                              type:
                                - number
                                - 'null'
                            cashFromToBorrower:
                              type:
                                - number
                                - 'null'
                        titleInfo:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - object
                            - 'null'
                          properties:
                            heldInNames:
                              type:
                                - string
                                - 'null'
                            currentlyHeldInNames:
                              type:
                                - string
                                - 'null'
                            estateType:
                              type:
                                - string
                                - 'null'
                            leaseholdExpiration:
                              type:
                                - string
                                - 'null'
                            mannerOfTitle:
                              type:
                                - string
                                - 'null'
                            trustInfo:
                              type:
                                - string
                                - 'null'
                            tribalLand:
                              type:
                                - boolean
                                - 'null'
                        loanOriginator:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - object
                            - 'null'
                          properties:
                            organizationName:
                              type:
                                - string
                                - 'null'
                            organizationNmlsId:
                              type:
                                - string
                                - 'null'
                            organizationStateLicense:
                              type:
                                - string
                                - 'null'
                            individualName:
                              type:
                                - string
                                - 'null'
                            individualNmlsId:
                              type:
                                - string
                                - 'null'
                            individualStateLicense:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                        otherNewMortgageLoans:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - array
                            - 'null'
                          items:
                            type: object
                            properties:
                              creditor:
                                type:
                                  - string
                                  - 'null'
                              lienType:
                                type:
                                  - string
                                  - 'null'
                              monthlyPayment:
                                type:
                                  - number
                                  - 'null'
                              loanAmount:
                                type:
                                  - number
                                  - 'null'
                              creditLimit:
                                type:
                                  - number
                                  - 'null'
                        giftsOrGrants:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - array
                            - 'null'
                          items:
                            type: object
                            properties:
                              assetType:
                                type:
                                  - string
                                  - 'null'
                              source:
                                type:
                                  - string
                                  - 'null'
                              deposited:
                                type:
                                  - boolean
                                  - 'null'
                              value:
                                type:
                                  - number
                                  - 'null'
                        program:
                          description: >-
                            The loan program (e.g. "30-year Fixed"). Present
                            unless the request's `fields` leaves it out.
                          type: string
                        lock:
                          description: >-
                            The rate lock, or null if unknown. Present unless
                            the request's `fields` leaves it out.
                          type:
                            - object
                            - 'null'
                          properties:
                            status:
                              type:
                                - string
                                - 'null'
                            date:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            expirationDate:
                              type:
                                - string
                                - 'null'
                              format: date-time
                        debtToIncome:
                          description: >-
                            Debt-to-income ratio, in percent. Present unless the
                            request's `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        combinedLoanToValue:
                          description: >-
                            Combined loan-to-value ratio of every loan on the
                            property, in percent. Present unless the request's
                            `fields` leaves it out.
                          type:
                            - number
                            - 'null'
                        firstTimeBuyer:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - boolean
                            - 'null'
                        estimatedClosingDate:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        firstPaymentDate:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - string
                            - 'null'
                          format: date-time
                        preApproval:
                          description: Present unless the request's `fields` leaves it out.
                          type:
                            - object
                            - 'null'
                          properties:
                            issuedDate:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            expirationDate:
                              type:
                                - string
                                - 'null'
                              format: date-time
                        denialReason:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        referralSource:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        milestoneDates:
                          description: >-
                            Dates of the loan's milestones beyond its own date
                            fields, or null if the source records none. Present
                            unless the request's `fields` leaves it out.
                          type:
                            - object
                            - 'null'
                          properties:
                            processingStarted:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            creditReportOrdered:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            appraisalOrdered:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            appraisalExpected:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            appraisalReceived:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            underwritingSubmitted:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            underwritingApproved:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            resubmitted:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            approved:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            clearToClose:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            docsOut:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            documentsSigned:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            closingDisclosureOut:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            closingDisclosureSigned:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            fundsRequested:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            fundingExpected:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            postClosed:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            audited:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            purchased:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            earlyPayoff:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            annualReview:
                              type:
                                - string
                                - 'null'
                              format: date-time
                        rolloutUpdated:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                          format: date-time
                      required:
                        - id
                    description: The records of this page, under the collection's name.
                required:
                  - _metadata
                  - loans
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
      security:
        - jwt: []
          credential_id: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend
    credential_id:
      type: apiKey
      in: header
      name: X-Rollout-Credential-Id
      description: The Rollout Credential ID to use for queries/mutations

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.