> ## 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 ## OpenAPI ````yaml /openapi/los.json get /loans openapi: 3.0.3 info: title: Universal LOS API Documentation description: Development documentation version: '1.0' servers: - url: https://los.universal.rollout.com/api security: [] paths: /loans: get: tags: - Loans summary: List Loans 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: 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 enum: - 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: nullable: true description: >- Cursor of the next page, to pass as `next`; null on the last page. type: string nextLink: nullable: true description: >- URL of the next page, this request's with `next` set; null on the last page. type: string 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. nullable: true type: string interestRate: description: Present unless the request's `fields` leaves it out. type: number amount: description: Present unless the request's `fields` leaves it out. type: number term: description: Present unless the request's `fields` leaves it out. nullable: true type: number loanToValue: description: Present unless the request's `fields` leaves it out. nullable: true type: number 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. nullable: true type: string applicationDate: description: Present unless the request's `fields` leaves it out. nullable: true type: string closingDate: description: Present unless the request's `fields` leaves it out. nullable: true type: string fundingDate: description: Present unless the request's `fields` leaves it out. nullable: true type: string 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 additionalProperties: anyOf: - type: number - type: string original: description: Present unless the request's `fields` leaves it out. type: object additionalProperties: type: object additionalProperties: {} created: description: Present unless the request's `fields` leaves it out. nullable: true type: string updated: description: Present unless the request's `fields` leaves it out. nullable: true type: string userParticipantIds: description: Present unless the request's `fields` leaves it out. type: array items: type: string borrowerParticipantIds: description: Present unless the request's `fields` leaves it out. type: array items: type: string stage: description: Present unless the request's `fields` leaves it out. type: string stageHistory: description: Present unless the request's `fields` leaves it out. nullable: true type: array items: type: object properties: id: type: string name: type: string status: type: string scheduledStartDate: nullable: true type: string format: date-time actualStartDate: nullable: true type: string format: date-time completedDate: nullable: true type: string format: date-time plannedDurationDays: nullable: true type: number actualDurationDays: nullable: true type: number assignee: nullable: true type: object properties: id: nullable: true type: string name: nullable: true type: string email: nullable: true type: string phone: nullable: true type: string role: nullable: true type: string required: - id - name - email - phone - role requiresReview: nullable: true type: boolean isReviewed: nullable: true type: boolean order: nullable: true type: number isRequired: nullable: true type: boolean notes: type: string metadata: nullable: true required: - id - name - status loanFolder: description: Present unless the request's `fields` leaves it out. nullable: true type: string archived: description: Present unless the request's `fields` leaves it out. nullable: true type: boolean mortgageType: description: Present unless the request's `fields` leaves it out. nullable: true type: string lienType: description: Present unless the request's `fields` leaves it out. nullable: true type: string amortizationType: description: Present unless the request's `fields` leaves it out. nullable: true type: string armInitialPeriodMonths: description: Present unless the request's `fields` leaves it out. nullable: true type: number armSubsequentPeriodMonths: description: Present unless the request's `fields` leaves it out. nullable: true type: number expectedRentalIncome: description: Present unless the request's `fields` leaves it out. nullable: true type: number expectedNetRentalIncome: description: Present unless the request's `fields` leaves it out. nullable: true type: number communityProperty: description: Present unless the request's `fields` leaves it out. nullable: true type: boolean transactionDetail: description: Present unless the request's `fields` leaves it out. nullable: true type: string refinanceType: description: Present unless the request's `fields` leaves it out. nullable: true type: string refinanceProgram: description: Present unless the request's `fields` leaves it out. nullable: true type: string energyImprovement: description: Present unless the request's `fields` leaves it out. nullable: true type: string projectType: description: Present unless the request's `fields` leaves it out. nullable: true type: string proposedMonthlyPayment: description: Present unless the request's `fields` leaves it out. nullable: true type: object properties: firstMortgagePI: nullable: true type: number subordinatePI: nullable: true type: number homeownersInsurance: nullable: true type: number supplementalInsurance: nullable: true type: number propertyTaxes: nullable: true type: number mortgageInsurance: nullable: true type: number associationDues: nullable: true type: number other: nullable: true type: number total: nullable: true type: number loanFeatures: description: Present unless the request's `fields` leaves it out. nullable: true type: object properties: balloon: nullable: true type: boolean interestOnly: nullable: true type: boolean negativeAmortization: nullable: true type: boolean prepaymentPenalty: nullable: true type: boolean temporaryBuydown: nullable: true type: boolean other: nullable: true type: string qualifyingFunds: description: Present unless the request's `fields` leaves it out. nullable: true type: object properties: dueFromBorrower: nullable: true type: number totalMortgageLoans: nullable: true type: number totalCredits: nullable: true type: number cashFromToBorrower: nullable: true type: number titleInfo: description: Present unless the request's `fields` leaves it out. nullable: true type: object properties: heldInNames: nullable: true type: string currentlyHeldInNames: nullable: true type: string estateType: nullable: true type: string leaseholdExpiration: nullable: true type: string mannerOfTitle: nullable: true type: string trustInfo: nullable: true type: string tribalLand: nullable: true type: boolean loanOriginator: description: Present unless the request's `fields` leaves it out. nullable: true type: object properties: organizationName: nullable: true type: string organizationNmlsId: nullable: true type: string organizationStateLicense: nullable: true type: string individualName: nullable: true type: string individualNmlsId: nullable: true type: string individualStateLicense: nullable: true type: string email: nullable: true type: string phone: nullable: true type: string otherNewMortgageLoans: description: Present unless the request's `fields` leaves it out. nullable: true type: array items: type: object properties: creditor: nullable: true type: string lienType: nullable: true type: string monthlyPayment: nullable: true type: number loanAmount: nullable: true type: number creditLimit: nullable: true type: number giftsOrGrants: description: Present unless the request's `fields` leaves it out. nullable: true type: array items: type: object properties: assetType: nullable: true type: string source: nullable: true type: string deposited: nullable: true type: boolean value: nullable: true type: number rolloutUpdated: description: Present unless the request's `fields` leaves it out. type: string 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 '409': description: Response for status 409 content: application/json: schema: type: object properties: errorMessage: type: string enum: - >- Data for this credential is not ready yet. Please try again. 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.