Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Delinquency Cases
Search the full API reference Esc to close

List Delinquency Cases

Billing · REST API reference

Get support
GET/v1/facilities/{facility_id}/delinquency/cases
One page of the collections queue, worst debtor first by default -- or, with `facility_id="all"`, of every facility's, interleaved by the sort.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/delinquency/cases' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · string | stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

pagequery · integer | null

1-based page number, for a numbered pager. Mutually exclusive with `cursor`.

Minimum: 1

sortquery · string

Default: "days_past_due" · Values: "days_past_due", "balance", "opened_on"

orderquery · string

Default: "desc" · Values: "asc", "desc"

stagequery · string | null

One delinquency state, or several comma-separated (any of them).

days_past_due_minquery · integer | null

Minimum: 0

days_past_due_maxquery · integer | null

Minimum: 0

has_arrangementquery · boolean | null

True for cases with an open engine-filed promise to pay.

assigned_toquery · string | null

The arrangement task's assignee.

Format: uuid

searchquery · string | null

Matches tenant name, tenant number or unit number.

closedquery · boolean

True for closed cases instead of open ones.

Default: false

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": [
    {
      "balance": "<VALUE_MATCHING_PATTERN>",
      "case_id": "00000000-0000-4000-8000-000000000001",
      "current_stage": "string",
      "days_past_due": 0,
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "fees_applied": "<VALUE_MATCHING_PATTERN>",
      "has_arrangement": false,
      "lease": {
        "id": "00000000-0000-4000-8000-000000000001",
        "lease_number": "string",
        "next_billing_date": "2026-10-29",
        "rate": "<VALUE_MATCHING_PATTERN>",
        "start_date": "2026-10-29",
        "status": "string",
        "tenant_id": "00000000-0000-4000-8000-000000000001",
        "tenant_name": "string",
        "unit_number": "string",
        "insurance_plan": {
          "coverage_amount": "<VALUE_MATCHING_PATTERN>",
          "id": "00000000-0000-4000-8000-000000000001",
          "monthly_premium": "<VALUE_MATCHING_PATTERN>",
          "name": "string"
        }
      },
      "lockout": {
        "gate_suspended": false,
        "unit_overlocked": false,
        "denied_provider": "string",
        "denied_since": "2026-10-29T12:00:00Z",
        "manual_hold": false
      },
      "monthly_rent": "<VALUE_MATCHING_PATTERN>",
      "opened_on": "2026-10-29",
      "recent_events": [
        {
          "balance_at_event": "<VALUE_MATCHING_PATTERN>",
          "created_at": "2026-10-29T12:00:00Z",
          "event_type": "string",
          "id": "00000000-0000-4000-8000-000000000001",
          "new_state": "string",
          "trigger_days": 0,
          "is_manual_override": false,
          "notes": "string"
        }
      ],
      "state": "string",
      "tenant": {
        "first_name": "string",
        "id": "00000000-0000-4000-8000-000000000001",
        "last_name": "string",
        "tenant_number": "string",
        "email": "string",
        "phone": "string"
      },
      "unit": {
        "id": "00000000-0000-4000-8000-000000000001",
        "unit_number": "string",
        "unit_type_name": "string"
      },
      "write_off_amount": "<VALUE_MATCHING_PATTERN>"
    }
  ],
  "meta": {
    "request_id": "string"
  },
  "pagination": {
    "has_more": false,
    "limit": 0,
    "cursor": "string",
    "total_count": 0
  },
  "metrics": {
    "cards": {},
    "computed_at": "2026-10-29T12:00:00Z",
    "is_stale": false,
    "scope": "facility"
  }
}

application/json

dataDelinquencyCaseResponse[]required
Show data schema
assigned_toUserCompactResponse | null

The arrangement task's assignee.

Show assigned_to schema
UserCompactResponse | null

The arrangement task's assignee.

Variant 1: UserCompactResponse
display_namestringrequired
emailstringrequired
idstringrequired

Format: uuid

Variant 2: null
null
auction_datestring | null

Scheduled sale date, once one has been recorded.

Format: date

Show auction_date schema
string | null

Scheduled sale date, once one has been recorded.

Variant 1: string
string
Variant 2: null
null
auction_locationstring | null

Where the sale takes place.

Show auction_location schema
string | null

Where the sale takes place.

Variant 1: string
string
Variant 2: null
null
auction_timestring | null

Scheduled sale time, as the operator entered it.

Show auction_time schema
string | null

Scheduled sale time, as the operator entered it.

Variant 1: string
string
Variant 2: null
null
balancestringrequired

Outstanding balance at the last sweep.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

case_idstringrequired

Unique identifier for this delinquency case.

Format: uuid

closed_atstring | null

When the case closed; null while it is open.

Format: date-time

Show closed_at schema
string | null

When the case closed; null while it is open.

Variant 1: string
string
Variant 2: null
null
closed_reasonstring | null

cured, written_off or lease_closed.

Show closed_reason schema
string | null

cured, written_off or lease_closed.

Variant 1: string
string
Variant 2: null
null
current_stagestringrequired

The same value as `state`, under the name earlier clients read.

days_past_dueintegerrequired

Days past the oldest unpaid rent-class due date, facility-local.

facility_idstringrequired

The facility the case belongs to -- every row carries it under `all`.

Format: uuid

fees_appliedstringrequired

Engine fees posted on this cycle, net of waivers. Delinquency-cycle fees only: the dispute fee is a payment-path charge posted by the dispute ingest, so it is not counted here even though it is classed as an engine fee on the ledger.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

has_arrangementbooleanrequired

True while an open collection task filed by the engine exists.

last_payment_amountstring | null

Amount of that payment.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show last_payment_amount schema
string | null

Amount of that payment.

Variant 1: string
string
Variant 2: null
null
last_payment_datestring | null

Business date of the tenant's most recent payment.

Format: date

Show last_payment_date schema
string | null

Business date of the tenant's most recent payment.

Variant 1: string
string
Variant 2: null
null
leaseLeaseCompactResponserequired
Show lease schema
idstringrequired

Unique identifier for the lease.

Format: uuid

insurance_planInsurancePlanCompactResponse | null

The protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.

Show insurance_plan schema
InsurancePlanCompactResponse | null

The protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.

Variant 1: InsurancePlanCompactResponse
coverage_amountstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

idstringrequired

Format: uuid

monthly_premiumstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

namestringrequired
Variant 2: null
null
lease_numberstringrequired

Operator-facing lease reference, unique within the facility.

next_billing_datestringrequired

Business date rent is next charged.

Format: date

ratestringrequired

Current monthly rent charged under this lease.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

start_datestringrequired

Business date the lease began.

Format: date

statusstringrequired

Lifecycle state of the lease.

tenant_idstringrequired

The tenant renting under this lease.

Format: uuid

tenant_namestringrequired

The tenant's display name, denormalized so a listing needs no second call.

unit_numberstringrequired

Label of the unit this lease occupies.

lockoutDelinquencyLockoutBlockrequired

The case's actual lock facts, which the Apply/Release buttons key on -- not the state label, which can say `locked_out` after a release.

Show lockout schema
denied_providerstring | null

The lock provider that confirmed it, for example kiss.

Show denied_provider schema
string | null

The lock provider that confirmed it, for example kiss.

Variant 1: string
string
Variant 2: null
null
denied_sincestring | null

When the lock provider confirmed it holds the unit denied; null when no provider has, or when the case's lease no longer occupies the unit.

Format: date-time

Show denied_since schema
string | null

When the lock provider confirmed it holds the unit denied; null when no provider has, or when the case's lease no longer occupies the unit.

Variant 1: string
string
Variant 2: null
null
gate_suspendedbooleanrequired

True while a delinquency suspension is live on the lease's access grant.

manual_holdboolean

True while a staff hold for a reason other than non-payment is on the lease's access. Releasing the delinquency lockout does not lift it.

Default: false

unit_overlockedbooleanrequired

True while the unit is overlocked and this case's lease is the one occupying it.

monthly_rentstringrequired

The lease's current monthly rent.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

next_actionstring | null

Display label of the next stage due to fire.

Show next_action schema
string | null

Display label of the next stage due to fire.

Variant 1: string
string
Variant 2: null
null
next_action_datestring | null

Business date that stage is due.

Format: date

Show next_action_date schema
string | null

Business date that stage is due.

Variant 1: string
string
Variant 2: null
null
next_stage_keystring | null

`{kind}:{index}` of the next stage in the case's snapshot.

Show next_stage_key schema
string | null

`{kind}:{index}` of the next stage in the case's snapshot.

Variant 1: string
string
Variant 2: null
null
next_statestring | null

The state that stage would move the case into.

Show next_state schema
string | null

The state that stage would move the case into.

Variant 1: string
string
Variant 2: null
null
next_state_onstring | null

Business date the next state is due.

Format: date

Show next_state_on schema
string | null

Business date the next state is due.

Variant 1: string
string
Variant 2: null
null
opened_onstringrequired

Business date the case was opened.

Format: date

overrideDelinquencyOverrideBlock | null

The last manual override, or null when the case has only ever moved by the ladder.

Show override schema
DelinquencyOverrideBlock | null

The last manual override, or null when the case has only ever moved by the ladder.

Variant 1: DelinquencyOverrideBlock
atstringrequired

When the override was applied.

Format: date-time

bystring | null

The staff user who applied the override.

Format: uuid

Show by schema
string | null

The staff user who applied the override.

Variant 1: string
Variant 2: null
reasonstring | null

The operator's stated reason.

Show reason schema
string | null

The operator's stated reason.

Variant 1: string
Variant 2: null
statestringrequired

The state the case was in when an operator last overrode the ladder.

Variant 2: null
null
pause_reasonstring | null

Why the case is paused: arrangement, exempt, manual, opposition or scra.

Show pause_reason schema
string | null

Why the case is paused: arrangement, exempt, manual, opposition or scra.

Variant 1: string
string
Variant 2: null
null
paused_untilstring | null

Business date the pause lifts; null when not paused.

Format: date

Show paused_until schema
string | null

Business date the pause lifts; null when not paused.

Variant 1: string
string
Variant 2: null
null
recent_eventsDelinquencyEventCompactResponse[]required

The five newest events on this case, newest first.

Show recent_events schema
balance_at_eventstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

created_atstringrequired

Format: date-time

event_typestringrequired
idstringrequired

Format: uuid

is_manual_overrideboolean

Default: false

new_statestringrequired
notesstring | null
Show notes schema
string | null
Variant 1: string
string
Variant 2: null
null
trigger_daysintegerrequired
statestringrequired

The case's current delinquency state.

tenantTenantCompactResponserequired

Inline tenant reference. Extended variant adds email/phone.

Show tenant schema
emailstring | null

Primary email address.

Show email schema
string | null

Primary email address.

Variant 1: string
string
Variant 2: null
null
first_namestringrequired

Given name.

idstringrequired

Unique identifier for the tenant.

Format: uuid

last_namestringrequired

Family name.

phonestring | null

Primary telephone number.

Show phone schema
string | null

Primary telephone number.

Variant 1: string
string
Variant 2: null
null
tenant_numberstringrequired

Operator-facing tenant reference, unique within the facility.

unitUnitCompactResponserequired
Show unit schema
idstringrequired

Format: uuid

unit_numberstringrequired
unit_type_namestringrequired
write_off_amountstringrequired

Amount written off on this cycle.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll billing operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

List Delinquency Cases | Facily Developers