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

List Rate Schedule Queue

Pricing & rates · REST API reference

Get support
GET/v1/facilities/{facility_id}/rate-schedules

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-schedules' \
  --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

bucketquery · string | null

Values: "on_notice", "due", "sending", "undelivered", "held", "in_effect", "withdrawn", "replaced"

statusquery · string | null

Comma-separated statuses.

Max length: 200

notice_statusquery · string | null

Comma-separated notice statuses.

Max length: 200

unit_group_idquery · string | null

Format: uuid

batch_idquery · string | null

Format: uuid

searchquery · string | null

Max length: 100

cursorquery · string | null
limitquery · integer

Default: 25 · Minimum: 1 · Maximum: 200

sortquery · string | null

Values: "effective_date", "created_at"

orderquery · string

Default: "asc" · Values: "asc", "desc"

Responses

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

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

Format: date-time

Show applied_at schema
string | null
Variant 1: string
string
Variant 2: null
null
batch_idstring | nullrequired

Format: uuid

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

Format: date-time

effective_datestringrequired

Format: date

facility_idstringrequired

Format: uuid

group_labelstring | nullrequired
Show group_label schema
string | null
Variant 1: string
string
Variant 2: null
null
held_reasonstring | nullrequired
Show held_reason schema
string | null
Variant 1: string
string
Variant 2: null
null
idstringrequired

Format: uuid

increase_pctstring | nullrequired

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

Show increase_pct schema
string | null
Variant 1: string
string
Variant 2: null
null
kindstringrequired
lease_idstringrequired

Format: uuid

lease_numberstringrequired
new_ratestringrequired

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

notice_attemptsintegerrequired
notice_channelstring | nullrequired
Show notice_channel schema
string | null
Variant 1: string
string
Variant 2: null
null
notice_datestring | nullrequired

The facility-local date the notice was sent or delivered.

Format: date

Show notice_date schema
string | null

The facility-local date the notice was sent or delivered.

Variant 1: string
string
Variant 2: null
null
notice_deadlinestringrequired

The last day a notice may reach the tenant for this effective date.

Format: date

notice_notestring | nullrequired
Show notice_note schema
string | null
Variant 1: string
string
Variant 2: null
null
notice_sent_atstring | nullrequired

Format: date-time

Show notice_sent_at schema
string | null
Variant 1: string
string
Variant 2: null
null
notice_statusstringrequired
previous_ratestringrequired

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

statusstringrequired
tenant_idstringrequired

Format: uuid

tenant_namestringrequired
unit_group_idstring | nullrequired

Format: uuid

Show unit_group_id schema
string | null
Variant 1: string
string
Variant 2: null
null
unit_idstringrequired

Format: uuid

unit_numberstringrequired
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 Rate Schedule Queue | Facily Developers