Get the applications dashboard
Returns the company-wide rental-application dashboard: how many applications sit in each pipeline stage, what needs attention, throughput metrics for the last 30 days, and generated observations. Requires the rental_applications:read permission.
Authorization
AuthorizationstringrequiredResponse
200 · The dashboard.
pipelineobjectHow applications are spread across the four pipeline stages.
actionQueueBucket[]Attention buckets that currently have at least one application, most urgent first. Empty buckets are left out, and the unpaid bucket is left out entirely when the company does not charge an application fee.
velocityobjectThroughput metrics. The two 30-day figures use rolling windows; the two monthly figures use calendar months in the company's timezone.
insightsInsight[]Generated observations about the pipeline, ready to display.
401 · The access token is missing, expired, or not valid.
403 · The caller is authenticated but does not hold the `rental_applications:read` permission.
The dashboard is held for 30 seconds per user, so calls made in quick succession return the same figures.