/v1/leases/{lease_id}/promotionsAuthentication
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/leases/<LEASE_ID>/promotions' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
lease_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"code": "string",
"created_at": "2026-10-29T12:00:00Z",
"current_month": 0,
"discount_summary": "string",
"ended_on": "2026-10-29",
"facility_id": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001",
"lease_id": "00000000-0000-4000-8000-000000000001",
"name": "string",
"promotion_id": "00000000-0000-4000-8000-000000000001",
"source": "string",
"starts_on": "2026-10-29",
"status": "scheduled",
"total_months": 0
}
],
"meta": {
"request_id": "string"
}
}application/json
dataLeasePromotionResponse[]requiredShow data schema
codestringrequiredThe promotion's code.
created_atstringrequiredFormat: date-time
current_monthinteger | nullrequiredWhile active: the month it is in ("month 2 of 4").
Show current_month schema
integer | nullWhile active: the month it is in ("month 2 of 4").
Variant 1: integer
integerVariant 2: null
nulldiscount_summarystringrequiredThe promotion's discount, as on the promotion.
ended_onstring | nullrequiredThe last day it covers. Null while it runs.
Format: date
Show ended_on schema
string | nullThe last day it covers. Null while it runs.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredFormat: uuid
idstringrequiredThe lease promotion (attachment).
Format: uuid
lease_idstringrequiredFormat: uuid
namestringrequiredThe promotion's name.
promotion_idstringrequiredFormat: uuid
sourcestringrequiredimport, staff or move_in.
starts_onstringrequiredThe start of the billing period that is month 1.
Format: date
statusstringrequiredRelative to the facility's today.
Values: "scheduled", "active", "ended"
total_monthsinteger | nullrequiredThe schedule's length; null when the last month repeats.
Show total_months schema
integer | nullThe schedule's length; null when the last month repeats.
Variant 1: integer
integerVariant 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