List loans ready to board

Request

Loans a banker released to the core and nobody has boarded yet, oldest first. A loan reaches this queue only once a banker releases it — being funded is not enough on its own. Acknowledge a board with POST /loans/{id}/boarding and the loan leaves the queue, so a scheduled pull only ever returns work that is still outstanding: a board that failed on your side simply stays. Pass boarded=true (optionally with boardedSince) to reconcile instead — the loans already boarded.

Security

ApiKeyAuth

Query

limitnumber, [ 1 .. 100 ]

Default:50

offsetnumber, >= 0

cursorstring

boardedstring

Default:"false"

Enum:"true""false"

boardedSincestring

curl -i -X GET \
  'https://api.pioneerft.com/api/public/v1/loans/boarding-queue?limit=50&offset=0&cursor=string&boarded=true&boardedSince=string' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Loans ready to board (or already boarded)

Bodyapplication/json

dataArray of objects(PublicLoan)

metaobject(PaginationMeta)

One of:

Response

{
  "data": [
    {
      "id": "string",
      "loanNumber": "string",
      "status": "string",
      "type": "business",
      "centsAmount": -9007199254740991,
      "centsMonthlyPayment": -9007199254740991,
      "monthsTerm": -9007199254740991,
      "monthsInterestOnly": -9007199254740991,
      "paymentFrequency": "weekly",
      "rateType": "fixed",
      "bpsRate": -9007199254740991,
      "purpose": "string",
      "purposeNarrative": "string",
      "applicationDate": "string",
      "closeDate": "string",
      "maturityDate": "string",
      "firstPaymentDate": "string",
      "product": {
        "id": "string",
        "name": "string"
      },
      "stage": {
        "id": "string",
        "name": "string"
      },
      "createdAt": "string",
      "updatedAt": "string",
      "boarding": {
        "loanId": "string",
        "status": "string",
        "releasable": true,
        "released": true,
        "releasedAt": "string",
        "releasedBy": "string",
        "boarded": true,
        "boardedAt": "string",
        "coreRecordNumber": "string"
      }
    }
  ],
  "meta": {
    "mode": "offset",
    "limit": 0,
    "offset": 0,
    "hasMore": true
  }
}