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

Get Partner Inventory

Partner · REST API reference

Get support
GET/v1/partner/facilities/{facility_id}/inventory
What can be rented now at the facility: unit groups priced at your channel's rate, the units that can be held, the promotions offered to your channel, required fees and lead sources. Read live; cache it for at most 60 seconds.

Authentication

Channel-scoped partner key.

A standard staff key is not interchangeable with a partner key. Call this endpoint from your server.

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/partner/facilities/<FACILITY_ID>/inventory' \
  --header "Authorization: Bearer $FACILY_PARTNER_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

facility_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": {
    "as_of": "2026-10-29T12:00:00Z",
    "fees": [
      {
        "amount": "<VALUE_MATCHING_PATTERN>",
        "code": "string",
        "fee_type": "string",
        "frequency": "string",
        "id": "00000000-0000-4000-8000-000000000001",
        "name": "string",
        "percentage": "<VALUE_MATCHING_PATTERN>"
      }
    ],
    "lead_sources": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "name": "string"
      }
    ],
    "promotions": [
      {
        "auto_apply": false,
        "code": "string",
        "description": "string",
        "discount_summary": "string",
        "id": "00000000-0000-4000-8000-000000000001",
        "min_stay_months": 0,
        "move_in_only": false,
        "name": "string",
        "prepay_months": 0,
        "prepay_required": false,
        "priority": 0,
        "repeat_last_month": false,
        "schedule": [
          {
            "amount": "<VALUE_MATCHING_PATTERN>",
            "discount_type": "string",
            "month_number": 0,
            "percentage": "<VALUE_MATCHING_PATTERN>"
          }
        ],
        "stackable": false,
        "valid_from": "2026-10-29",
        "valid_until": "2026-10-29"
      }
    ],
    "rate_basis": "street",
    "unit_groups": [
      {
        "available_units": [
          {
            "floor": 0,
            "id": "00000000-0000-4000-8000-000000000001",
            "rate": "<VALUE_MATCHING_PATTERN>",
            "street_rate": "<VALUE_MATCHING_PATTERN>",
            "unit_number": "string"
          }
        ],
        "depth_feet": "<VALUE_MATCHING_PATTERN>",
        "feature_names": [
          "string"
        ],
        "fee_ids": [
          "00000000-0000-4000-8000-000000000001"
        ],
        "floor": 0,
        "id": "00000000-0000-4000-8000-000000000001",
        "name": "string",
        "price_tiers": [
          {
            "available_count": 0,
            "rate": "<VALUE_MATCHING_PATTERN>",
            "street_rate": "<VALUE_MATCHING_PATTERN>"
          }
        ],
        "promotion_ids": [
          "00000000-0000-4000-8000-000000000001"
        ],
        "unit_type": "string",
        "width_feet": "<VALUE_MATCHING_PATTERN>"
      }
    ]
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataPartnerInventoryResponserequired
Show data schema
as_ofstringrequired

Format: date-time

feesPartnerFeeResponse[]required

Required fees, for display; move-in quotes the binding cost.

Show fees schema
amountstring | nullrequired

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

Show amount schema
string | null
Variant 1: string
string
Variant 2: null
null
codestringrequired
fee_typestringrequired

flat, percentage or custom.

frequencystringrequired

one_time, monthly or annual.

idstringrequired

Format: uuid

namestringrequired
percentagestring | nullrequired

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

Show percentage schema
string | null
Variant 1: string
string
Variant 2: null
null
lead_sourcesPartnerLeadSourceResponse[]required
Show lead_sources schema
idstringrequired

Format: uuid

namestringrequired
promotionsPartnerPromotionResponse[]required
Show promotions schema
auto_applybooleanrequired
codestringrequired
descriptionstring | nullrequired
Show description schema
string | null
Variant 1: string
string
Variant 2: null
null
discount_summarystringrequired
idstringrequired

Format: uuid

min_stay_monthsinteger | nullrequired
Show min_stay_months schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
move_in_onlybooleanrequired
namestringrequired
prepay_monthsinteger | nullrequired
Show prepay_months schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
prepay_requiredbooleanrequired
priorityinteger | nullrequired
Show priority schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
repeat_last_monthbooleanrequired
schedulePartnerScheduleRowResponse[]required
Show schedule schema
amountstring | nullrequired

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

Show amount schema
string | null
Variant 1: string
Variant 2: null
discount_typestringrequired

percentage, flat or none.

month_numberintegerrequired
percentagestring | nullrequired

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

Show percentage schema
string | null
Variant 1: string
Variant 2: null
stackablebooleanrequired
valid_fromstring | nullrequired

Format: date

Show valid_from schema
string | null
Variant 1: string
string
Variant 2: null
null
valid_untilstring | nullrequired

Format: date

Show valid_until schema
string | null
Variant 1: string
string
Variant 2: null
null
rate_basisstringrequired

Which rate your channel is shown and held at.

Values: "street", "web"

unit_groupsPartnerUnitGroupResponse[]required
Show unit_groups schema
available_unitsPartnerUnitResponse[]required
Show available_units schema
floorinteger | nullrequired
Show floor schema
integer | null
Variant 1: integer
Variant 2: null
idstringrequired

Format: uuid

ratestringrequired

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

street_ratestring | nullrequired

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

Show street_rate schema
string | null
Variant 1: string
Variant 2: null
unit_numberstringrequired
depth_feetstring | nullrequired

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

Show depth_feet schema
string | null
Variant 1: string
string
Variant 2: null
null
feature_namesstring[]required
Show feature_names schema
string
fee_idsstring[]required
Show fee_ids schema
string
floorinteger | nullrequired
Show floor schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
idstringrequired

Format: uuid

namestringrequired
price_tiersPartnerPriceTierResponse[]required

One per distinct rate; empty when sold out.

Show price_tiers schema
available_countintegerrequired
ratestringrequired

The channel's rate: send it as expected_rate to reserve at this price.

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

street_ratestring | nullrequired

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

Show street_rate schema
string | null
Variant 1: string
Variant 2: null
promotion_idsstring[]required

Promotions offered on this group to your channel now.

Show promotion_ids schema
string
unit_typestring | nullrequired

The members' unit type when they share one.

Show unit_type schema
string | null

The members' unit type when they share one.

Variant 1: string
string
Variant 2: null
null
width_feetstring | nullrequired

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

Show width_feet 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
Continue exploringAll partner operations
Build something that works beautifully.

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

Get Partner Inventory | Facily Developers