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

    MethodInterface
    /v0/listingsListings
    Example: 983defee-1245-4545-9db6-506b69c944e5
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    MethodInterface
    /v0/listingsListings
    Example: bce66892-3808-4ee9-9df2-7bfcda243084
    x_unit_idstring | nullnullablerequired

    The external ID of the unit from the integration vendor

    MethodInterface
    /v0/listingsListings
    Example: 74ab00b3-393f-40ac-88df-92e6b6051dcd
    x_floor_plan_idstring | nullnullablerequired

    The external ID of the floor plan from the integration vendor

    MethodInterface
    /v0/listingsListings
    Example: 22cd4f16-fad2-4ec6-ad75-0f13f1a43f42
    is_unitbooleanrequired

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

    MethodInterface
    /v0/listingsListings
    Example: true
    available_datestring | nullnullablerequired

    The date the listing is available

    MethodInterface
    /v0/listingsListings
    Example: 2023-07-25T00:00:00.000Z
    application_urlstring | nullnullablerequired

    The application URL for the listing

    MethodInterface
    /v0/listingsListings
    Example: https://example.appfolio.com/listings/rental_applications/new?listable_uid=2095219a-fc39-4b58-92f1-7ab1b3cef370
    bathroomsstring | nullnullablerequired

    The number of bathrooms associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: 2.5
    bathrooms_fullnumber | nullnullablerequired

    The number of full bathrooms associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: 2
    bathrooms_halfnumber | nullnullablerequired

    The number of half bathrooms associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: 1
    bedroomsstring | nullnullablerequired

    The number of bedrooms associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: 2
    building_namenullrequired

    The building name associated with the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    building_numbernullrequired

    The building number associated with the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    citystring | nullnullablerequired

    The city associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: Austin
    countrynullrequired

    The country associated with the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    custom_data object | nullrequired
    object
    deposit_amount_in_centsnumber | nullnullablerequired

    The deposit amount in cents associated with the listing

    MethodInterface
    /v0/listingsListings
    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

    MethodInterface
    /v0/listingsListings
    Example: 4e4d03ca-ad4a-403a-9326-8eb5e1d61dd7
    floor_plan_namestring | nullnullablerequireddeprecated

    The floor plan name associated with the listing

    Important

    Deprecated in favor of floor_plan_id

    MethodInterface
    /v0/listingsListings
    Example: 1 Bedroom Unit
    floornullrequired

    The floor number/name associated with the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    image_urlsstring[]required

    A list of image urls associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: ["https: //images.cdn.appfolio.com/example/images/7c65166f-64b6-48fd-840f-7a005689452f/large.png"]
    is_availablenullrequired

    Whether the listing is available

    Notice

    This field will always be null for APPFOLIO

    Example: null
    is_furnishednullrequired

    Whether the listing is furnished

    Notice

    This field will always be null for APPFOLIO

    Example: null
    is_listedboolean | nullnullablerequired

    Whether the listing is listed

    MethodInterface
    /v0/listingsListings
    Example: true
    is_managed_externalnullrequired

    Whether the listing is managed externally

    Notice

    This field will always be null for APPFOLIO

    Example: null
    is_vacantnullrequired

    Whether the listing is vacant

    Notice

    This field will always be null for APPFOLIO

    Example: null
    lease_termnullrequired

    The term of the lease

    Notice

    This field will always be null for APPFOLIO

    Example: null
    listing_titlestring | nullnullablerequired

    The title used for the marketing listing

    MethodInterface
    /v0/listingsListings
    Example: Our finest unit
    listing_datenullrequired

    The date the listing was created

    Notice

    This field will always be null for APPFOLIO

    Example: null
    marketing_namenullrequired

    The marketing name of the unit being listed

    Notice

    This field will always be null for APPFOLIO

    Example: null
    notesnullrequired

    Notes associated with the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    numbernullrequired

    The unit number

    Notice

    This field will always be null for APPFOLIO

    Example: null
    rent_amount_in_centsnumber | nullnullablerequired

    The rent amount in cents for the listing

    MethodInterface
    /v0/listingsListings
    Example: 150000
    specialsnullrequired

    Marketing specials or promotions for the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    square_feetinteger | nullnullablerequired

    The square footage of the listing

    MethodInterface
    /v0/listingsListings

    Possible values: >= 0

    Example: 535
    statestring | nullnullablerequired

    The state associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: TX
    street_address_1string | nullnullablerequireddeprecated

    Deprecated: Use address_1

    MethodInterface
    /v0/listingsListings
    street_address_2string | nullnullablerequireddeprecated

    Deprecated: Use address_2

    MethodInterface
    /v0/listingsListings
    address_1string | nullnullablerequired

    The first address line associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: 410 Oak Street
    address_2string | nullnullablerequired

    The second address line associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: 410 Oak Street
    property_descriptionstring | nullnullablerequired

    Description of the property

    Important

    This is based on PropertyMarketingDescription. On request, we can add a custom_data field for PropertyMarketingTitle as well.

    MethodInterface
    /v0/listingsListings
    Example: Our finest property
    short_descriptionstring | nullnullablerequired

    A short description of the listing

    MethodInterface
    /v0/listingsListings
    Example: Itaque autem ut. Et id vel. Temporibus vero ad.
    unit_descriptionnullrequired

    Description of the unit

    Notice

    This field will always be null for APPFOLIO

    Example: null
    zipstring | nullnullablerequired

    The zip code associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: 78704
    make_ready_datenullrequired

    The make ready date of the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    vacate_datenullrequired

    The vacate date of the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    video_urlsstring[]nullablerequired

    A list of video urls associated with the listing

    MethodInterface
    /v0/listingsListings
    Example: ["https://www.youtube.com/watch?v=jNQXAC9IVRw"]
    status_rawnullrequired

    The raw status associated with the listing

    Notice

    This field will always be null for APPFOLIO

    Example: null
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh
    unit_idstring | nullnullablerequired

    The Propexo unique identifier for the unit

    MethodInterface
    /v0/listingsListings
    Example: cm9k2n4p8000108l4exunit01
    floor_plan_idstring | nullnullablerequired

    The Propexo unique identifier for the floor plan

    MethodInterface
    /v0/listingsListings
    Example: cm7xvp5vb88803888363al35e7bse4z
    integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum13required

    The property management system of record

    Show 13 enum values
    APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
    Example: APPFOLIO
    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 APPFOLIO

    Example: null
    unit_type_idnullrequired

    The Propexo unique identifier for the unit type

    Notice

    This field will always be null for APPFOLIO

    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": "983defee-1245-4545-9db6-506b69c944e5",
      "x_property_id": "bce66892-3808-4ee9-9df2-7bfcda243084",
      "x_unit_id": "74ab00b3-393f-40ac-88df-92e6b6051dcd",
      "x_floor_plan_id": "22cd4f16-fad2-4ec6-ad75-0f13f1a43f42",
      "is_unit": true,
      "available_date": "2023-07-25T00:00:00.000Z",
      "application_url": "https://example.appfolio.com/listings/rental_applications/new?listable_uid=2095219a-fc39-4b58-92f1-7ab1b3cef370",
      "bathrooms": "2.5",
      "bathrooms_full": 2,
      "bathrooms_half": 1,
      "bedrooms": "2",
      "building_name": null,
      "building_number": null,
      "city": "Austin",
      "country": null,
      "custom_data": "Unknown Type: object,null",
      "deposit_amount_in_cents": 150000,
      "floor": null,
      "image_urls": [
        "https: //images.cdn.appfolio.com/example/images/7c65166f-64b6-48fd-840f-7a005689452f/large.png"
      ],
      "is_available": null,
      "is_furnished": null,
      "is_listed": true,
      "is_managed_external": null,
      "is_vacant": null,
      "lease_term": null,
      "listing_title": "Our finest unit",
      "listing_date": null,
      "marketing_name": null,
      "notes": null,
      "number": null,
      "rent_amount_in_cents": 150000,
      "specials": null,
      "square_feet": 535,
      "state": "TX",
      "address_1": "410 Oak Street",
      "address_2": "410 Oak Street",
      "property_description": "Our finest property",
      "short_description": "Itaque autem ut. Et id vel. Temporibus vero ad.",
      "unit_description": null,
      "zip": "78704",
      "make_ready_date": null,
      "vacate_date": null,
      "video_urls": [
        "https://www.youtube.com/watch?v=jNQXAC9IVRw"
      ],
      "status_raw": null,
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "unit_id": "cm9k2n4p8000108l4exunit01",
      "floor_plan_id": "cm7xvp5vb88803888363al35e7bse4z",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "APPFOLIO",
      "x_location_id": null,
      "unit_type_id": null
    }
  ]
}