Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Unit Group Promotions
Search the full API reference Esc to close

List Unit Group Promotions

Unit groups · REST API reference

Get support
GET/v1/unit-groups/{unit_group_id}/promotions
The current promotions a unit of this group can be offered, by code. Unpaged.

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/unit-groups/<UNIT_GROUP_ID>/promotions' \
  --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

unit_group_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": [
    {
      "active_group_ids": [
        "00000000-0000-4000-8000-000000000001"
      ],
      "applicability_rules": {},
      "applicable_unit_group_ids": [
        "00000000-0000-4000-8000-000000000001"
      ],
      "auto_apply": false,
      "channel_ids": [
        "00000000-0000-4000-8000-000000000001"
      ],
      "code": "string",
      "created_at": "2026-10-29T12:00:00Z",
      "current_uses": 0,
      "description": "string",
      "discount_summary": "string",
      "existing_tenant_only": false,
      "facility_ids": [
        "00000000-0000-4000-8000-000000000001"
      ],
      "governed_by_rules": false,
      "has_attachments": false,
      "hide_from_website": false,
      "id": "00000000-0000-4000-8000-000000000001",
      "is_active": false,
      "live_attachment_count": 0,
      "max_uses": 0,
      "min_available_units": 0,
      "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,
      "updated_at": "2026-10-29T12:00:00Z",
      "valid_from": "2026-10-29",
      "valid_until": "2026-10-29"
    }
  ],
  "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

dataPromotionResponse[]required
Show data schema
active_group_idsstring[]required

The live unit groups promotion rules switch it on for now, limited the same way: the listed facility's, the readable facilities', or every facility's.

Show active_group_ids schema
string
applicability_rulesobject | nullrequired

Stored operator rules; not evaluated.

Show applicability_rules schema
object | null

Stored operator rules; not evaluated.

Variant 1: object
object
Variant 2: null
null
applicable_unit_group_idsstring[] | nullrequired

Unit groups it applies to; null means every unit.

Show applicable_unit_group_ids schema
string[] | null

Unit groups it applies to; null means every unit.

Variant 1: string[]
string[]
Variant 2: null
null
auto_applybooleanrequired

Applied automatically at move-in when it qualifies (move-in, a later step).

channel_idsstring[]required

Lead channels offered it online. Empty: every channel, unless hide_from_website.

Show channel_ids schema
string
codestringrequired

Shown on bills and receipts.

created_atstringrequired

When the promotion was created.

Format: date-time

current_usesintegerrequired

How many leases it has been applied to.

descriptionstring | nullrequired

Free-text description.

Show description schema
string | null

Free-text description.

Variant 1: string
string
Variant 2: null
null
discount_summarystringrequired

Server-composed summary, e.g. "50% off month 1", "Months 2 and 4 free".

existing_tenant_onlybooleanrequired

Only for tenants who already rent another unit.

facility_idsstring[]required

Facilities the promotion covers. Empty means every facility.

Show facility_ids schema
string
governed_by_rulesbooleanrequired

True when an active promotion rule governs it: at the listed facility on a facility's list; at one or more of the facilities you can read on GET by id; anywhere otherwise. Where it is governed it is offered only on the unit groups its rules switched on.

has_attachmentsbooleanrequired

True once any lease has used it; the discount is then read-only.

hide_from_websitebooleanrequired

For staff use; not advertised online.

idstringrequired

Unique identifier for this promotion.

Format: uuid

is_activebooleanrequired

Whether it is switched on, independent of its date window.

live_attachment_countintegerrequired

Leases carrying it now.

max_usesinteger | nullrequired

Maximum number of leases it may be applied to. Null means unlimited.

Show max_uses schema
integer | null

Maximum number of leases it may be applied to. Null means unlimited.

Variant 1: integer
integer
Variant 2: null
null
min_available_unitsinteger | nullrequired

Only offered while at least this many units of the group are free (live count).

Show min_available_units schema
integer | null

Only offered while at least this many units of the group are free (live count).

Variant 1: integer
integer
Variant 2: null
null
min_stay_monthsinteger | nullrequired

Minimum stay the promotion asks for, in months.

Show min_stay_months schema
integer | null

Minimum stay the promotion asks for, in months.

Variant 1: integer
integer
Variant 2: null
null
move_in_onlybooleanrequired

Only at move-in; it cannot be applied to an existing lease.

namestringrequired

Operator-facing promotion name.

prepay_monthsinteger | nullrequired

Months that must be prepaid, when prepay_required is true.

Show prepay_months schema
integer | null

Months that must be prepaid, when prepay_required is true.

Variant 1: integer
integer
Variant 2: null
null
prepay_requiredbooleanrequired

The tenant must prepay to qualify.

priorityinteger | nullrequired

Stack order: a lower number first, 0 valid, null last.

Show priority schema
integer | null

Stack order: a lower number first, 0 valid, null last.

Variant 1: integer
integer
Variant 2: null
null
repeat_last_monthbooleanrequired

True when the last schedule row repeats for as long as the lease runs.

schedulePromotionScheduleRowResponse[]required

The month-by-month discount, by month_number.

Show schedule schema
amountstring | nullrequired

For flat rows: dollars off that month.

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

Show amount schema
string | null

For flat rows: dollars off that month.

Variant 1: string
string
Variant 2: null
null
discount_typestringrequired

percentage, flat or none.

month_numberintegerrequired

1 is the billing period the promotion starts in.

percentagestring | nullrequired

For percentage rows.

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

Show percentage schema
string | null

For percentage rows.

Variant 1: string
string
Variant 2: null
null
stackablebooleanrequired

Whether this promotion may combine with another on the same lease.

updated_atstringrequired

When the promotion last changed.

Format: date-time

valid_fromstring | nullrequired

First date it may be applied.

Format: date

Show valid_from schema
string | null

First date it may be applied.

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

Last date it may be applied. Null means it does not expire.

Format: date

Show valid_until schema
string | null

Last date it may be applied. Null means it does not expire.

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
Continue exploringAll unit groups operations
Build something that works beautifully.

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

List Unit Group Promotions | Facily Developers