Skip to main content

Get all listings

GEThttps://api.propexo.com/v1/listings/

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 listing id

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.

unit_id string

The Propexo unique identifier for the unit

property_id string

The Propexo unique identifier for the property

integration_id string

The Propexo integration id

integration_vendor string
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The integration vendor for the listing.

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 listing

    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

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    propertyunits/getPropertyUnits
    Example: unitX123
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    propertyunits/getPropertyUnits
    Example: propertyX123
    x_unit_idstring | nullnullablerequired

    The external ID of the unit from the integration vendor

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: unitX123
    x_floor_plan_idstring | nullnullablerequired

    The external ID of the floor plan from the integration vendor

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: FP123
    is_unitnullrequired

    True if the listing is for a unit, false if it is not associated with a specific unit

    Notice

    This field will always be null for ENTRATA

    Example: null
    available_datestring | nullnullablerequired

    The date the listing is available

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 2023-07-01T00:00:00.000Z
    application_urlnullrequired

    The application URL for the listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    bathroomsstring | nullnullablerequired

    The number of bathrooms associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 2
    bathrooms_fullnumber | nullnullablerequired

    The number of full bathrooms associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 2
    bathrooms_halfnumber | nullnullablerequired

    The number of half bathrooms associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    bedroomsstring | nullnullablerequired

    The number of bedrooms associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 3
    building_namestring | nullnullablerequired

    The building name associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: Sunset Apartments
    building_numbernullrequired

    The building number associated with the listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    citystring | nullnullablerequired

    The city associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: San Francisco
    countrynullrequired

    The country associated with the listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    custom_data object | nullrequired
    object
    deposit_amount_in_centsnumber | nullnullablerequired

    The deposit amount in cents associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 150000
    floor_plan_codestring | nullnullablerequireddeprecated

    The external ID of the floor plan associated with the listing

    Important

    Deprecated in favor of floor_plan_id

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: FP123
    floor_plan_namestring | nullnullablerequireddeprecated

    The floor plan name associated with the listing

    Important

    Deprecated in favor of floor_plan_id

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: Luxury 3 Bedroom
    floorstring | nullnullablerequired

    The floor number/name associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 2
    image_urlsstring[]required

    A list of image urls associated with the listing

    Method
    propertyunits/getPropertyUnits
    Example: ["https://example.com/image1.jpg","https://example.com/image2.jpg"]
    is_availableboolean | nullnullablerequired

    Whether the listing is available

    Important

    Set to true when the unit space is available, false when not available, and null otherwise.

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: true
    is_furnishednullrequired

    Whether the listing is furnished

    Notice

    This field will always be null for ENTRATA

    Example: null
    is_listedboolean | nullnullablerequired

    Whether the listing is listed

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: true
    is_managed_externalnullrequired

    Whether the listing is managed externally

    Notice

    This field will always be null for ENTRATA

    Example: null
    is_vacantboolean | nullnullablerequired

    Whether the listing is vacant

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    lease_termstring | nullnullablerequired

    The term of the lease

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 12 months
    listing_titlenullrequired

    The title used for the marketing listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    listing_datenullrequired

    The date the listing was created

    Notice

    This field will always be null for ENTRATA

    Example: null
    marketing_namenullrequired

    The marketing name of the unit being listed

    Notice

    This field will always be null for ENTRATA

    Example: null
    notesnullrequired

    Notes associated with the listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    numberstring | nullnullablerequired

    The unit number

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 101
    rent_amount_in_centsnumber | nullnullablerequired

    The rent amount in cents for the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 250000
    specialsnullrequired

    Marketing specials or promotions for the listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    square_feetinteger | nullnullablerequired

    The square footage of the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing

    Possible values: >= 0

    Example: 1200
    statestring | nullnullablerequired

    The state associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: CA
    street_address_1string | nullnullablerequireddeprecated

    Deprecated: Use address_1

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    street_address_2string | nullnullablerequireddeprecated

    Deprecated: Use address_2

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    address_1string | nullnullablerequired

    The first address line associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 123 Main St
    address_2string | nullnullablerequired

    The second address line associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 123 Main St
    property_descriptionnullrequired

    Description of the property

    Notice

    This field will always be null for ENTRATA

    Example: null
    short_descriptionnullrequired

    A short description of the listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    unit_descriptionnullrequired

    Description of the unit

    Notice

    This field will always be null for ENTRATA

    Example: null
    zipstring | nullnullablerequired

    The zip code associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 94103
    make_ready_datestring | nullnullablerequired

    The make ready date of the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: 2023-06-25T00:00:00.000Z
    vacate_datenullrequired

    The vacate date of the listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    video_urlsnullrequired

    A list of video urls associated with the listing

    Notice

    This field will always be null for ENTRATA

    Example: null
    status_rawstring | nullnullablerequired

    The raw status associated with the listing

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: Vacant Ready (Available)
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh
    unit_idstring | nullnullablerequired

    The Propexo unique identifier for the unit

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: unit123
    floor_plan_idstring | nullnullablerequired

    The Propexo unique identifier for the floor plan

    Method
    propertyunits/getUnitsAvailabilityAndPricing
    Example: cm7xvp5vb88803888363al35e7bse4z
    integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum15required

    The property management system of record

    Show 13 enum values
    ENTRATAAPPFOLIOBUILDIUMMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
    Example: ENTRATA
    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 ENTRATA

    Example: null
    unit_type_idnullrequired

    The Propexo unique identifier for the unit type

    Notice

    This field will always be null for ENTRATA

    Example: null
  • ]

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/listings/
curl https://api.propexo.com/v1/listings/ \
     -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": "unitX123",
      "x_property_id": "propertyX123",
      "x_unit_id": "unitX123",
      "x_floor_plan_id": "FP123",
      "is_unit": null,
      "available_date": "2023-07-01T00:00:00.000Z",
      "application_url": null,
      "bathrooms": "2",
      "bathrooms_full": 2,
      "bathrooms_half": 0,
      "bedrooms": "3",
      "building_name": "Sunset Apartments",
      "building_number": null,
      "city": "San Francisco",
      "country": null,
      "custom_data": "Unknown Type: object,null",
      "deposit_amount_in_cents": 150000,
      "floor": "2",
      "image_urls": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
      ],
      "is_available": true,
      "is_furnished": null,
      "is_listed": true,
      "is_managed_external": null,
      "is_vacant": true,
      "lease_term": "12 months",
      "listing_title": null,
      "listing_date": null,
      "marketing_name": null,
      "notes": null,
      "number": "101",
      "rent_amount_in_cents": 250000,
      "specials": null,
      "square_feet": 1200,
      "state": "CA",
      "address_1": "123 Main St",
      "address_2": "123 Main St",
      "property_description": null,
      "short_description": null,
      "unit_description": null,
      "zip": "94103",
      "make_ready_date": "2023-06-25T00:00:00.000Z",
      "vacate_date": null,
      "video_urls": null,
      "status_raw": "Vacant Ready (Available)",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "unit_id": "unit123",
      "floor_plan_id": "cm7xvp5vb88803888363al35e7bse4z",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "ENTRATA",
      "x_location_id": null,
      "unit_type_id": null
    }
  ]
}