/v1/facilities/{facility_id}/rate-schedulesAuthentication
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>/rate-schedules' \
--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
bucketquery · string | nullValues: "on_notice", "due", "sending", "undelivered", "held", "in_effect", "withdrawn", "replaced"
statusquery · string | nullComma-separated statuses.
Max length: 200
notice_statusquery · string | nullComma-separated notice statuses.
Max length: 200
unit_group_idquery · string | nullFormat: uuid
batch_idquery · string | nullFormat: uuid
searchquery · string | nullMax length: 100
cursorquery · string | nulllimitquery · integerDefault: 25 · Minimum: 1 · Maximum: 200
sortquery · string | nullValues: "effective_date", "created_at"
orderquery · stringDefault: "asc" · Values: "asc", "desc"
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"applied_at": "2026-10-29T12:00:00Z",
"batch_id": "00000000-0000-4000-8000-000000000001",
"created_at": "2026-10-29T12:00:00Z",
"effective_date": "2026-10-29",
"facility_id": "00000000-0000-4000-8000-000000000001",
"group_label": "string",
"held_reason": "string",
"id": "00000000-0000-4000-8000-000000000001",
"increase_pct": "<VALUE_MATCHING_PATTERN>",
"kind": "string",
"lease_id": "00000000-0000-4000-8000-000000000001",
"lease_number": "string",
"new_rate": "<VALUE_MATCHING_PATTERN>",
"notice_attempts": 0,
"notice_channel": "string",
"notice_date": "2026-10-29",
"notice_deadline": "2026-10-29",
"notice_note": "string",
"notice_sent_at": "2026-10-29T12:00:00Z",
"notice_status": "string",
"previous_rate": "<VALUE_MATCHING_PATTERN>",
"status": "string",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"tenant_name": "string",
"unit_group_id": "00000000-0000-4000-8000-000000000001",
"unit_id": "00000000-0000-4000-8000-000000000001",
"unit_number": "string"
}
],
"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
dataRateScheduleQueueRowResponse[]requiredShow data schema
applied_atstring | nullrequiredFormat: date-time
Show applied_at schema
string | nullVariant 1: string
stringVariant 2: null
nullbatch_idstring | nullrequiredFormat: uuid
Show batch_id schema
string | nullVariant 1: string
stringVariant 2: null
nullcreated_atstringrequiredFormat: date-time
effective_datestringrequiredFormat: date
facility_idstringrequiredFormat: uuid
group_labelstring | nullrequiredShow group_label schema
string | nullVariant 1: string
stringVariant 2: null
nullheld_reasonstring | nullrequiredShow held_reason schema
string | nullVariant 1: string
stringVariant 2: null
nullidstringrequiredFormat: uuid
increase_pctstring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show increase_pct schema
string | nullVariant 1: string
stringVariant 2: null
nullkindstringrequiredlease_idstringrequiredFormat: uuid
lease_numberstringrequirednew_ratestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
notice_attemptsintegerrequirednotice_channelstring | nullrequiredShow notice_channel schema
string | nullVariant 1: string
stringVariant 2: null
nullnotice_datestring | nullrequiredThe facility-local date the notice was sent or delivered.
Format: date
Show notice_date schema
string | nullThe facility-local date the notice was sent or delivered.
Variant 1: string
stringVariant 2: null
nullnotice_deadlinestringrequiredThe last day a notice may reach the tenant for this effective date.
Format: date
notice_notestring | nullrequiredShow notice_note schema
string | nullVariant 1: string
stringVariant 2: null
nullnotice_sent_atstring | nullrequiredFormat: date-time
Show notice_sent_at schema
string | nullVariant 1: string
stringVariant 2: null
nullnotice_statusstringrequiredprevious_ratestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
statusstringrequiredtenant_idstringrequiredFormat: uuid
tenant_namestringrequiredunit_group_idstring | nullrequiredFormat: uuid
Show unit_group_id schema
string | nullVariant 1: string
stringVariant 2: null
nullunit_idstringrequiredFormat: uuid
unit_numberstringrequiredmetaMetarequiredEnvelope 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