Skip to content
BookendBookend Docs

Get pipeline status

GET
/v1/loans/{ref}/pipeline
curl --request GET \
  --url http://localhost:8080/v1/loans/example/pipeline

Returns, per document, the stage grid of its latest run (each stage pending, running, retrying, completed, skipped or failed with attempts, timings and detail), plus whether the whole package is complete and whether any stage failed. Earlier runs stay in evidence. Any staff role or an API key with status:read. 404 for an unknown reference.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ref
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
loanId
required
string format: uuid
externalRef
required
string
packageVersion
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
state
required
string
documents
required
Array<object>
object
documentId
required
string format: uuid
originalName
required
string
docType
required
string
isLar
required
boolean
pageCount
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
runId
required
null | string format: uuid
stages
required
Array<object>
object
stage
required
string
status
required
string
attempt
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
startedAt
required
null | string format: date-time
completedAt
required
null | string format: date-time
elapsedMs
required
null | integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
detail
required
null | string
nextRetryAt
required
null | string format: date-time
isComplete
required
boolean
hasFailed
required
boolean
isComplete
required
boolean
hasFailures
required
boolean
Examplegenerated
{
  "loanId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "externalRef": "example",
  "packageVersion": 1,
  "state": "example",
  "documents": [
    {
      "documentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "originalName": "example",
      "docType": "example",
      "isLar": true,
      "pageCount": 1,
      "runId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "stages": [
        {
          "stage": "example",
          "status": "example",
          "attempt": 1,
          "startedAt": "2026-04-15T12:00:00Z",
          "completedAt": "2026-04-15T12:00:00Z",
          "elapsedMs": 1,
          "detail": "example",
          "nextRetryAt": "2026-04-15T12:00:00Z"
        }
      ],
      "isComplete": true,
      "hasFailed": true
    }
  ],
  "isComplete": true,
  "hasFailures": true
}