Skip to content

Search loans

Request

Advanced loan search with complex filtering capabilities. Supports multiple status filters, stage, banker and broker filters, loan number, free text, date ranges, amount ranges (in whole cents), and custom sorting. For an incremental sync, filter with updatedSince and sort by updatedAt with offset paging. updatedAt moves when the loan record changes, so a change to a sub-resource such as the loan team or a document does not always move it. Use this endpoint when you need more control than the basic list endpoint.

Security
ApiKeyAuth
Bodyapplication/json

Search criteria

filtersobject
paginationobject
sortobject
curl -i -X POST \
  https://api.pioneerft.com/api/public/v1/loans/search \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": {
      "status": [
        "draft"
      ],
      "productIds": [
        "string"
      ],
      "stageIds": [
        "string"
      ],
      "bankerIds": [
        "string"
      ],
      "brokerIds": [
        "string"
      ],
      "loanNumber": "string",
      "q": "string",
      "updatedSince": "string",
      "centsAmountMin": -9007199254740991,
      "centsAmountMax": -9007199254740991,
      "dateRange": {
        "from": "string",
        "to": "string"
      }
    },
    "pagination": {
      "limit": 50,
      "offset": 0,
      "cursor": "string"
    },
    "sort": {
      "field": "createdAt",
      "order": "asc"
    }
  }'

Responses

Successful response with search results

Bodyapplication/json
dataArray of objects(PublicLoan)
metaobject(PaginationMeta)
One of:
Response
{ "data": [ { "id": "string", "loanNumber": "string", "status": "draft", "type": "business", "centsAmount": -9007199254740991, "centsMonthlyPayment": -9007199254740991, "monthsTerm": -9007199254740991, "monthsInterestOnly": -9007199254740991, "paymentFrequency": "weekly", "rateType": "fixed", "bpsRate": -9007199254740991, "bpsFixedRate": -9007199254740991, "bpsPrimeRate": -9007199254740991, "bpsSpreadRate": -9007199254740991, "rateDiscount": { "id": "string", "name": "string", "bpsRate": -9007199254740991 }, "borrowerName": "string", "purpose": "string", "purposeNarrative": "string", "applicationDate": "string", "closeDate": "string", "maturityDate": "string", "firstPaymentDate": "string", "product": { "id": "string", "name": "string" }, "stage": { "id": "string", "name": "string", "parent": { "id": "string", "name": "string" } }, "createdAt": "string", "updatedAt": "string", "centsDeposit": -9007199254740991, "depositDisposition": "refunded", "closingCostsMode": "estimate", "centsEstimatedClosingCosts": -9007199254740991, "monthsReamortizationTerm": -9007199254740991, "paymentType": "ACH", "prepaymentPenalty": [ { "year": -9007199254740991, "bpsRate": -9007199254740991 } ], "rateBenchmarkId": "string", "effectiveRateBenchmark": { "id": "string", "code": "string", "name": "string", "coreCode": "string", "bpsRate": -9007199254740991, "isActive": true }, "initialDisbursementDate": "string", "firstRateChangeDate": "string", "crmRecordNumber": "string", "documentRetentionRecordNumber": "string", "centsReferralFeeOverride": -9007199254740991, "bpsReferralFeeOverride": -9007199254740991, "referralFeePaidBy": "bank", "centsPackagingFeeOverride": -9007199254740991, "bpsPackagingFeeOverride": -9007199254740991, "packagingFeePaidBy": "bank", "centsInterestOnlyPayment": -9007199254740991, "centsAmortizingPayment": -9007199254740991, "interestMethod": "30/360", "yearBase": "Actual/365 Payments P&I", "ratePeriods": [ { "phaseName": "string", "monthsLength": -9007199254740991, "rateKind": "fixed", "rateBenchmarkId": "string", "monthsAdjustment": -9007199254740991 } ], "paymentSchedule": [ { "segmentType": "Interest Only", "numberOfPayments": -9007199254740991, "firstPaymentDate": "string", "centsPayment": -9007199254740991 } ] } ], "meta": { "mode": "offset", "limit": 0, "offset": 0, "hasMore": true } }