/v1/unit-groups/{unit_group_id}/rate-changesAuthentication
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/unit-groups/<UNIT_GROUP_ID>/rate-changes' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
unit_group_idpath · stringrequiredFormat: uuid
cursorquery · string | nulllimitquery · integerDefault: 50 · Minimum: 1 · Maximum: 200
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"created_at": "2026-10-29T12:00:00Z",
"created_by": "00000000-0000-4000-8000-000000000001",
"facility_id": "00000000-0000-4000-8000-000000000001",
"field": "string",
"id": "00000000-0000-4000-8000-000000000001",
"source": "string",
"group_label": "string",
"new_value": "<VALUE_MATCHING_PATTERN>",
"old_value": "<VALUE_MATCHING_PATTERN>",
"rule_ids": [
"00000000-0000-4000-8000-000000000001"
],
"unit_group_id": "00000000-0000-4000-8000-000000000001",
"unit_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
dataRateChangeResponse[]requiredShow data schema
created_atstringrequiredFormat: date-time
created_bystringrequiredFormat: uuid
facility_idstringrequiredFormat: uuid
fieldstringrequiredstreet, web, min (the floor) or max (the ceiling).
group_labelstring | nullThe group's code or name when the change happened.
Show group_label schema
string | nullThe group's code or name when the change happened.
Variant 1: string
stringVariant 2: null
nullidstringrequiredFormat: uuid
new_valuestring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show new_value schema
string | nullVariant 1: string
stringVariant 2: null
nullold_valuestring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show old_value schema
string | nullVariant 1: string
stringVariant 2: null
nullrule_idsstring[]The rules applying, when source is rule.
Show rule_ids schema
stringsourcestringrequiredoperator, rule, import, override, override_cleared or bulk_import.
unit_group_idstring | nullNull once the group has been permanently removed.
Format: uuid
Show unit_group_id schema
string | nullNull once the group has been permanently removed.
Variant 1: string
stringVariant 2: null
nullunit_idstring | nullSet on a unit-level row; null on a group-level row.
Format: uuid
Show unit_id schema
string | nullSet on a unit-level row; null on a group-level row.
Variant 1: string
stringVariant 2: null
nullunit_numberstring | nullThe unit's number on a unit-level row.
Show unit_number schema
string | nullThe unit's number on a unit-level row.
Variant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope 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