/v1/facilities/{facility_id}/delinquency/eventsAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --request GET \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/delinquency/events' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · string | stringrequiredFormat: uuid
cursorquery · string | nulllimitquery · integerDefault: 50 · Minimum: 1 · Maximum: 200
orderquery · stringDefault: "desc" · Values: "asc", "desc"
case_idquery · string | nullFormat: uuid
lease_idquery · string | nullFormat: uuid
event_typequery · string | nullfromquery · string | nullInclusive lower bound on created_at.
Format: date-time
toquery · string | nullExclusive upper bound on created_at.
Format: date-time
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"actions_taken": [
{}
],
"balance_at_event": "<VALUE_MATCHING_PATTERN>",
"created_at": "2026-10-29T12:00:00Z",
"created_by": "00000000-0000-4000-8000-000000000001",
"event_type": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_manual_override": false,
"lease_id": "00000000-0000-4000-8000-000000000001",
"new_state": "string",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"trigger_days": 0,
"case_id": "00000000-0000-4000-8000-000000000001"
}
],
"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
dataDelinquencyEventResponse[]requiredShow data schema
actions_takenobject[]requiredOne record per action the stage carried out, with what it produced.
Show actions_taken schema
objectbalance_at_eventstringrequiredThe ledger balance at the moment the event fired.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
case_idstring | nullThe case it belongs to; null on imported pre-Step-10 rows.
Format: uuid
Show case_id schema
string | nullThe case it belongs to; null on imported pre-Step-10 rows.
Variant 1: string
stringVariant 2: null
nullcreated_atstringrequiredWhen the row was written.
Format: date-time
created_bystringrequiredThe actor the row is attributed to.
Format: uuid
event_typestringrequiredWhat happened, for example stage_fired, paused or manual_override.
idstringrequiredUnique identifier for this event.
Format: uuid
is_manual_overridebooleanrequiredTrue when an operator, not the sweep, caused the event.
lease_idstringrequiredThe lease the event is against.
Format: uuid
new_statestringrequiredThe state the case was in after the event.
notesstring | nullFree text: the operator's reason on a manual event.
Show notes schema
string | nullFree text: the operator's reason on a manual event.
Variant 1: string
stringVariant 2: null
nullprevious_statestring | nullThe state the case was in before the event.
Show previous_state schema
string | nullThe state the case was in before the event.
Variant 1: string
stringVariant 2: null
nullstage_keystring | null`{kind}:{index}` of the stage this event concerns.
Show stage_key schema
string | null`{kind}:{index}` of the stage this event concerns.
Variant 1: string
stringVariant 2: null
nulltenant_idstringrequiredThe tenant the event is against.
Format: uuid
trigger_daysintegerrequiredDays past due when the event fired.
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequiredmetricsEmbeddedMetrics | nullShow metrics schema
EmbeddedMetrics | nullVariant 1: EmbeddedMetrics
cardsobjectrequiredcomputed_atstring | nullrequiredFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullis_stalebooleanrequiredscopestringrequiredValues: "facility", "portfolio"
Variant 2: null
nullpaginationPaginationBlockrequiredPagination metadata for list responses.
Show pagination schema
cursorstring | nullShow cursor schema
string | nullVariant 1: string
stringVariant 2: null
nullhas_morebooleanrequiredlimitintegerrequiredtotal_countinteger | nullShow total_count schema
integer | nullVariant 1: integer
integerVariant 2: null
null400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired