/v1/partner/facilities/{facility_id}/inventoryAuthentication
Channel-scoped partner key.
A standard staff key is not interchangeable with a partner key. Call this endpoint from your server.
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/partner/facilities/<FACILITY_ID>/inventory' \
--header "Authorization: Bearer $FACILY_PARTNER_KEY"Parameters
facility_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataPartnerInventoryResponserequiredShow data schema
as_ofstringrequiredFormat: date-time
feesPartnerFeeResponse[]requiredRequired fees, for display; move-in quotes the binding cost.
Show fees schema
amountstring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
string | nullVariant 1: string
stringVariant 2: null
nullcodestringrequiredfee_typestringrequiredflat, percentage or custom.
frequencystringrequiredone_time, monthly or annual.
idstringrequiredFormat: uuid
namestringrequiredpercentagestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show percentage schema
string | nullVariant 1: string
stringVariant 2: null
nulllead_sourcesPartnerLeadSourceResponse[]requiredShow lead_sources schema
idstringrequiredFormat: uuid
namestringrequiredpromotionsPartnerPromotionResponse[]requiredShow promotions schema
auto_applybooleanrequiredcodestringrequireddescriptionstring | nullrequiredShow description schema
string | nullVariant 1: string
stringVariant 2: null
nulldiscount_summarystringrequiredidstringrequiredFormat: uuid
min_stay_monthsinteger | nullrequiredShow min_stay_months schema
integer | nullVariant 1: integer
integerVariant 2: null
nullmove_in_onlybooleanrequirednamestringrequiredprepay_monthsinteger | nullrequiredShow prepay_months schema
integer | nullVariant 1: integer
integerVariant 2: null
nullprepay_requiredbooleanrequiredpriorityinteger | nullrequiredShow priority schema
integer | nullVariant 1: integer
integerVariant 2: null
nullrepeat_last_monthbooleanrequiredschedulePartnerScheduleRowResponse[]requiredShow schedule schema
amountstring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
string | nullVariant 1: string
Variant 2: null
discount_typestringrequiredpercentage, flat or none.
month_numberintegerrequiredpercentagestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show percentage schema
string | nullVariant 1: string
Variant 2: null
stackablebooleanrequiredvalid_fromstring | nullrequiredFormat: date
Show valid_from schema
string | nullVariant 1: string
stringVariant 2: null
nullvalid_untilstring | nullrequiredFormat: date
Show valid_until schema
string | nullVariant 1: string
stringVariant 2: null
nullrate_basisstringrequiredWhich rate your channel is shown and held at.
Values: "street", "web"
unit_groupsPartnerUnitGroupResponse[]requiredShow unit_groups schema
available_unitsPartnerUnitResponse[]requiredShow available_units schema
floorinteger | nullrequiredShow floor schema
integer | nullVariant 1: integer
Variant 2: null
idstringrequiredFormat: uuid
ratestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
street_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show street_rate schema
string | nullVariant 1: string
Variant 2: null
unit_numberstringrequireddepth_feetstring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show depth_feet schema
string | nullVariant 1: string
stringVariant 2: null
nullfeature_namesstring[]requiredShow feature_names schema
stringfee_idsstring[]requiredShow fee_ids schema
stringfloorinteger | nullrequiredShow floor schema
integer | nullVariant 1: integer
integerVariant 2: null
nullidstringrequiredFormat: uuid
namestringrequiredprice_tiersPartnerPriceTierResponse[]requiredOne per distinct rate; empty when sold out.
Show price_tiers schema
available_countintegerrequiredratestringrequiredThe channel's rate: send it as expected_rate to reserve at this price.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
street_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show street_rate schema
string | nullVariant 1: string
Variant 2: null
promotion_idsstring[]requiredPromotions offered on this group to your channel now.
Show promotion_ids schema
stringunit_typestring | nullrequiredThe members' unit type when they share one.
Show unit_type schema
string | nullThe members' unit type when they share one.
Variant 1: string
stringVariant 2: null
nullwidth_feetstring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show width_feet schema
string | nullVariant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation 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