/v1/rent-raises/{batch_id}Authentication
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/rent-raises/<BATCH_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
batch_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"added_annual": "<VALUE_MATCHING_PATTERN>",
"added_monthly": "<VALUE_MATCHING_PATTERN>",
"avg_new_rate": "<VALUE_MATCHING_PATTERN>",
"avg_previous_rate": "<VALUE_MATCHING_PATTERN>",
"created_at": "2026-10-29T12:00:00Z",
"created_by": "00000000-0000-4000-8000-000000000001",
"display_status": "needs_attention",
"effective_date": "2026-10-29",
"facility_id": "00000000-0000-4000-8000-000000000001",
"file_name": "string",
"id": "00000000-0000-4000-8000-000000000001",
"mode": "string",
"note": "string",
"refused_count": 0,
"scheduled_count": 0,
"skipped": [
{
"lease_id": "00000000-0000-4000-8000-000000000001",
"reason": "string"
}
],
"skipped_count": 0,
"source": "string",
"status_counts": {
"applied": 0,
"cancelled": 0,
"held": 0,
"replaced": 0,
"scheduled": 0,
"undeliverable": 0
},
"target_label": "string",
"unit_group_id": "00000000-0000-4000-8000-000000000001",
"value": "<VALUE_MATCHING_PATTERN>"
},
"meta": {
"request_id": "string"
}
}application/json
dataRentRaiseBatchDetailResponserequiredShow data schema
added_annualstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
added_monthlystringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
avg_new_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show avg_new_rate schema
string | nullVariant 1: string
stringVariant 2: null
nullavg_previous_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show avg_previous_rate schema
string | nullVariant 1: string
stringVariant 2: null
nullcreated_atstringrequiredFormat: date-time
created_bystringrequiredFormat: uuid
display_statusstringrequiredValues: "needs_attention", "on_notice", "in_effect", "withdrawn", "replaced", "nothing_scheduled"
effective_datestring | nullrequiredFormat: date
Show effective_date schema
string | nullVariant 1: string
stringVariant 2: null
nullfacility_idstringrequiredFormat: uuid
file_namestring | nullrequiredShow file_name schema
string | nullVariant 1: string
stringVariant 2: null
nullidstringrequiredFormat: uuid
modestringrequiredpercent, new_rate or per_lease.
notestring | nullrequiredShow note schema
string | nullVariant 1: string
stringVariant 2: null
nullrefused_countintegerrequiredscheduled_countintegerrequiredskippedRentRaiseSkippedEntry[]requiredUp to 2,000 skipped and refused leases with their reason.
Show skipped schema
lease_idstringrequiredFormat: uuid
reasonstring | nullrequiredShow reason schema
string | nullVariant 1: string
stringVariant 2: null
nullskipped_countintegerrequiredsourcestringrequiredgroup, lease, spreadsheet, policy or import.
status_countsRentRaiseStatusCountsrequiredShow status_counts schema
appliedintegerrequiredcancelledintegerrequiredheldintegerrequiredreplacedintegerrequiredscheduledintegerrequiredundeliverableintegerrequiredtarget_labelstringrequiredunit_group_idstring | nullrequiredFormat: uuid
Show unit_group_id schema
string | nullVariant 1: string
stringVariant 2: null
nullvaluestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show value schema
string | nullVariant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation 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