Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Rent Raise
Search the full API reference Esc to close

Get Rent Raise

Pricing & rates · REST API reference

Get support
GET/v1/rent-raises/{batch_id}

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/rent-raises/<BATCH_ID>' \
  --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

batch_idpath · stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "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

dataRentRaiseBatchDetailResponserequired
Show data schema
added_annualstringrequired

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

added_monthlystringrequired

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

avg_new_ratestring | nullrequired

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

Show avg_new_rate schema
string | null
Variant 1: string
string
Variant 2: null
null
avg_previous_ratestring | nullrequired

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

Show avg_previous_rate schema
string | null
Variant 1: string
string
Variant 2: null
null
created_atstringrequired

Format: date-time

created_bystringrequired

Format: uuid

display_statusstringrequired

Values: "needs_attention", "on_notice", "in_effect", "withdrawn", "replaced", "nothing_scheduled"

effective_datestring | nullrequired

Format: date

Show effective_date schema
string | null
Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

Format: uuid

file_namestring | nullrequired
Show file_name schema
string | null
Variant 1: string
string
Variant 2: null
null
idstringrequired

Format: uuid

modestringrequired

percent, new_rate or per_lease.

notestring | nullrequired
Show note schema
string | null
Variant 1: string
string
Variant 2: null
null
refused_countintegerrequired
scheduled_countintegerrequired
skippedRentRaiseSkippedEntry[]required

Up to 2,000 skipped and refused leases with their reason.

Show skipped schema
lease_idstringrequired

Format: uuid

reasonstring | nullrequired
Show reason schema
string | null
Variant 1: string
string
Variant 2: null
null
skipped_countintegerrequired
sourcestringrequired

group, lease, spreadsheet, policy or import.

status_countsRentRaiseStatusCountsrequired
Show status_counts schema
appliedintegerrequired
cancelledintegerrequired
heldintegerrequired
replacedintegerrequired
scheduledintegerrequired
undeliverableintegerrequired
target_labelstringrequired
unit_group_idstring | nullrequired

Format: uuid

Show unit_group_id schema
string | null
Variant 1: string
string
Variant 2: null
null
valuestring | nullrequired

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

Show value schema
string | null
Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
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
Build something that works beautifully.

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

Get Rent Raise | Facily Developers