Skip to main content

Get all floor plans

GEThttps://api.propexo.com/v1/floor-plans/

Authentication​

  • AuthorizationBearer
    Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters​

order-by string

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

Default value: created_at:desc
updated_at_gte string | null

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_lte string | null

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

last_seen_gte string | null

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_lte string | null

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0
limit integer | null

Possible values: >= 0 and <= 250

A number between 1 and 250 to determine the number of results to return in a single query

Default value: 100
x_id string

The external ID from the integration vendor

location_id string

The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

property_id string

The Propexo unique identifier for the property

integration_id string

The Propexo unique identifier for the integration

integration_vendor string
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The property management system of record

Response​

Successful response

    meta objectrequired
    offsetinteger

    The offset of the first result

    Possible values: >= 0

    Example: 0
    limitinteger

    The number of results to return

    Possible values: >= 0 and <= 250

    Example: 100
    orderBy object[]required

    The order of the results

  • Array [
    • object
  • ]
    • hasMoreboolean | nullnullable

    Whether there are more results

    totalinteger

    The total number of results

    Possible values: >= 0

    Example: 1000
    results object[]required
  • Array [
    • idstringrequired

    The Propexo unique identifier for the floor plan

    Example: clwktsp9v000008l31iv218hn
    created_atstringrequired

    The date record first entered Propexo

    Example: 2024-03-21T15:38:08.337Z
    updated_atstringrequired

    The date record was last updated in Propexo

    Example: 2024-03-22T10:59:45.119Z
    last_seenstring | nullnullablerequired

    The date the record was last seen from the PMS

    Example: 2024-03-22T10:59:45.119Z
    x_idstringrequired

    The external ID from the integration vendor

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList
    Example: cgd44dmgef58ayq3gb5qrrhqk
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList
    Example: 1000001
    x_location_idnullrequired

    The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

    Notice

    This field will always be null for REALPAGE

    Example: null
    namestringrequired

    The name associated with the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList
    Example: One Bedroom
    marketing_namenullrequired

    The marketing name of the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    codestring | nullnullablerequired

    The code associated with the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList
    Example: A1
    descriptionstring | nullnullablerequired

    Description of the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList
    Example: One bedroom, one bath
    bedroomsinteger | nullnullablerequired

    The number of bedrooms associated with the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList

    Possible values: >= 0

    Example: 1
    bathroomsnullrequired

    The number of bathrooms associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    bathrooms_fullinteger | nullnullablerequired

    The number of full bathrooms associated with the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList

    Possible values: >= 0

    Example: 1
    bathrooms_halfinteger | nullnullablerequired

    The number of half bathrooms associated with the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList

    Possible values: >= 0

    max_occupantsinteger | nullnullablerequired

    The maximum number of occupants for the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList

    Possible values: >= 0

    Example: 2
    rentable_square_feetinteger | nullnullablerequired

    The rentable square footage of the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList

    Possible values: >= 0

    Example: 850
    gross_square_feetinteger | nullnullablerequired

    The gross square footage of the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList

    Possible values: >= 0

    Example: 920
    rent_minimum_in_centsnumber | nullnullablerequired

    The minimum rent of the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList
    Example: 150000
    rent_maximum_in_centsnumber | nullnullablerequired

    The maximum rent of the floor plan

    InterfaceMethod
    Pricing and Availability ODEGetFloorPlanList
    Pricing and Availability ODEList
    Example: 185000
    image_urlsnullrequired

    A list of image urls associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    unit_countnullrequired

    The number of units associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    deposit_amount_in_centsnullrequired

    The deposit amount in cents associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    deposit_amount_rawnullrequired

    The raw deposit amount associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    deposit_amount_min_in_centsnullrequired

    The minimum deposit amount in cents associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    deposit_amount_max_in_centsnullrequired

    The maximum deposit amount in cents associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    deposit_amount_min_rawnullrequired

    The raw minimum deposit amount associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    deposit_amount_max_rawnullrequired

    The raw maximum deposit amount associated with the floor plan

    Notice

    This field will always be null for REALPAGE

    Example: null
    custom_data object | nullrequired
    object
    integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum19required

    The property management system of record

    Show 13 enum values
    REALPAGEAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
    Example: REALPAGE
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh
  • ]

Errors​

  • 400Bad Request
      error objectrequired
      codestringrequired
      Example: invalid_request
      messagestringrequired
      Example: invalid request
      details object
      property name*any
      Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
GET /v1/floor-plans/
curl https://api.propexo.com/v1/floor-plans/ \
     -H "Authorization: Bearer <token>"
200 Successful response
{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "id": "clwktsp9v000008l31iv218hn",
      "created_at": "2024-03-21T15:38:08.337Z",
      "updated_at": "2024-03-22T10:59:45.119Z",
      "last_seen": "2024-03-22T10:59:45.119Z",
      "x_id": "cgd44dmgef58ayq3gb5qrrhqk",
      "x_property_id": "1000001",
      "x_location_id": null,
      "name": "One Bedroom",
      "marketing_name": null,
      "code": "A1",
      "description": "One bedroom, one bath",
      "bedrooms": 1,
      "bathrooms": null,
      "bathrooms_full": 1,
      "bathrooms_half": 0,
      "max_occupants": 2,
      "rentable_square_feet": 850,
      "gross_square_feet": 920,
      "rent_minimum_in_cents": 150000,
      "rent_maximum_in_cents": 185000,
      "image_urls": null,
      "unit_count": null,
      "deposit_amount_in_cents": null,
      "deposit_amount_raw": null,
      "deposit_amount_min_in_cents": null,
      "deposit_amount_max_in_cents": null,
      "deposit_amount_min_raw": null,
      "deposit_amount_max_raw": null,
      "custom_data": "Unknown Type: object,null",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "REALPAGE",
      "property_id": "clwi5xiix000008l6ctdgafyh"
    }
  ]
}