Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Facility Rate Changes
Search the full API reference Esc to close

List Facility Rate Changes

Pricing & rates · REST API reference

Get support
GET/v1/facilities/{facility_id}/rate-changes
The facility's (or, with `all`, the org's) rate change log, newest first.

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/facilities/<FACILITY_ID>/rate-changes' \
  --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

facility_idpath · string | stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

Responses

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

200Successful Response
JSON · generated example
{
  "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[]required
Show data schema
created_atstringrequired

Format: date-time

created_bystringrequired

Format: uuid

facility_idstringrequired

Format: uuid

fieldstringrequired

street, web, min (the floor) or max (the ceiling).

group_labelstring | null

The group's code or name when the change happened.

Show group_label schema
string | null

The group's code or name when the change happened.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Format: uuid

new_valuestring | null

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

Show new_value schema
string | null
Variant 1: string
string
Variant 2: null
null
old_valuestring | null

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

Show old_value schema
string | null
Variant 1: string
string
Variant 2: null
null
rule_idsstring[]

The rules applying, when source is rule.

Show rule_ids schema
string
sourcestringrequired

operator, rule, import, override, override_cleared or bulk_import.

unit_group_idstring | null

Null once the group has been permanently removed.

Format: uuid

Show unit_group_id schema
string | null

Null once the group has been permanently removed.

Variant 1: string
string
Variant 2: null
null
unit_idstring | null

Set on a unit-level row; null on a group-level row.

Format: uuid

Show unit_id schema
string | null

Set on a unit-level row; null on a group-level row.

Variant 1: string
string
Variant 2: null
null
unit_numberstring | null

The unit's number on a unit-level row.

Show unit_number schema
string | null

The unit's number on a unit-level row.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
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

List Facility Rate Changes | Facily Developers