Facilities
List facilities
List the grants your Tenancy holds, narrowed to one Client when the parameter names one.
GET
This call answers the Facilities your Tenancy has created, newest first, and narrows to one Client when you name one.
A Client may hold several live grants at once. None supersedes another, and the Platform states no ceiling across them — so this is the call that shows a screen everything one borrower has been granted.
The list carries no headroom. Deriving it is one question per grant into the loan domain, and most callers of a list do not need it. Read a Facility for the remainder.
Path parameters
string
required
The Tenancy whose grants are listed. Another Tenancy’s path answers
403.Query parameters
string
Narrows the list to one Client. Absent, the whole Tenancy’s grants are answered.Present with no value is refused rather than treated as absent. A list that quietly dropped an unreadable narrowing would answer with every grant of the Tenancy — a wider answer than you asked for, on the surface that says how much a borrower may still draw.
Response
array
required
The grants, newest first. Each carries every field the creation answers and neither
drawn nor headroom.A Tenancy that holds none, and a Client that holds none, are both answered an empty array rather than null.Several grants at once
Nothing here ends, reduces or supersedes anything else in the list. Each grant caps only the Loans issued under it, and a Client holding two live grants may draw the whole headroom of each. That is a stated position rather than an omission. A Tenancy that needs a ceiling across a borrower’s grants enforces it in its own system, out of the totals this call and the Facility read serve.Refusals
This route takes no body.
A read-scoped key is enough.