> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.propexo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server. # Get a listing by ID GET https://api.propexo.com/v1/listings/{listing_id} Get a listing by ID Reference: https://docs.propexo.com/api-reference/pms-generic-ap-is/listings/get-a-listing-by-id ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.propexo.com` (Production, default) - `https://api.sandbox.propexo.com` (Sandbox) ## Request ### Path parameters - `listing_id` (string, required) — The ID of the resource. ### Query parameters - `order-by` (string, optional, default: created_at:desc) — Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc - `updated_at_gte` (string, optional, nullable) — Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z) - `updated_at_lte` (string, optional, nullable) — Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z) - `last_seen_gte` (string, optional, nullable) — 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, optional, nullable) — 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, optional, nullable, default: 0) — Can be used for paginating results - `limit` (integer, optional, nullable, default: 100) — A number between 1 and 250 to determine the number of results to return in a single query ## Response ### 200 Successful response - `meta` (ResponseMeta, required) - `results` (Listing, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### ResponseMeta - `orderBy` (list of ResponseMetaOrderByItems, required) - `offset` (integer, optional) — The offset of the first result - `limit` (integer, optional) — The number of results to return - `hasMore` (boolean, optional, nullable) — Whether there are more results - `total` (integer, optional) — The total number of results ### Listing - `id` (string, required) — The Propexo unique identifier for the listing - `created_at` (string, required) — The date record first entered Propexo - `updated_at` (string, required) — The date record was last updated in Propexo - `last_seen` (string, required, nullable) — The date the record was last seen from the PMS - `x_id` (string, required) — The external ID from the integration vendor - `x_property_id` (string, required) — The external ID of the property from the integration vendor - `x_unit_id` (string, required, nullable) — The external ID of the unit from the integration vendor - `x_floor_plan_id` (string, required, nullable) — The external ID of the floor plan from the integration vendor - `is_unit` (boolean, required) — True if the listing is for a unit, false if it is not associated with a specific unit - `available_date` (string, required, nullable) — The date the listing is available - `application_url` (string, required, nullable) — The application URL for the listing - `bathrooms` (string, required, nullable) — The number of bathrooms associated with the listing - `bathrooms_full` (double, required, nullable) — The number of full bathrooms associated with the listing - `bathrooms_half` (double, required, nullable) — The number of half bathrooms associated with the listing - `bedrooms` (string, required, nullable) — The number of bedrooms associated with the listing - `building_name` (string, required, nullable) — The building name associated with the listing - `building_number` (string, required, nullable) — The building number associated with the listing - `city` (string, required, nullable) — The city associated with the listing - `country` (string, required, nullable) — The country associated with the listing - `custom_data` (ListingCustomData, required, nullable) - `deposit_amount_in_cents` (double, required, nullable) — The deposit amount in cents associated with the listing - `floor_plan_code` (string, required, nullable) — The external ID of the floor plan associated with the listing - `floor_plan_name` (string, required, nullable) — The floor plan name associated with the listing - `floor` (string, required, nullable) — The floor number/name associated with the listing - `image_urls` (list of string, required) - `is_available` (boolean, required, nullable) — Whether the listing is available - `is_furnished` (boolean, required, nullable) — Whether the listing is furnished - `is_listed` (boolean, required, nullable) — Whether the listing is listed - `is_managed_external` (boolean, required, nullable) — Whether the listing is managed externally - `is_vacant` (boolean, required, nullable) — Whether the listing is vacant - `lease_term` (string, required, nullable) — The term of the lease - `listing_title` (string, required, nullable) — The title used for the marketing listing - `listing_date` (string, required, nullable) — The date the listing was created - `marketing_name` (string, required, nullable) — The marketing name of the unit being listed - `notes` (string, required, nullable) — Notes associated with the listing - `number` (string, required, nullable) — The unit number - `rent_amount_in_cents` (double, required, nullable) — The rent amount in cents for the listing - `specials` (string, required, nullable) — Marketing specials or promotions for the listing - `square_feet` (integer, required, nullable) — The square footage of the listing - `state` (string, required, nullable) — The state associated with the listing - `address_1` (string, required, nullable) — The first address line associated with the listing - `address_2` (string, required, nullable) — The second address line associated with the listing - `property_description` (string, required, nullable) — Description of the property - `short_description` (string, required, nullable) — A short description of the listing - `unit_description` (string, required, nullable) — Description of the unit - `zip` (string, required, nullable) — The zip code associated with the listing - `make_ready_date` (string, required, nullable) — The make ready date of the listing - `vacate_date` (string, required, nullable) — The vacate date of the listing - `video_urls` (list of string, required, nullable) - `status_raw` (string, required, nullable) — The raw status associated with the listing - `property_id` (string, required) — The Propexo unique identifier for the property - `unit_id` (string, required, nullable) — The Propexo unique identifier for the unit - `floor_plan_id` (string, required, nullable) — The Propexo unique identifier for the floor plan - `integration_id` (string, required) — The Propexo unique identifier for the integration - `integration_vendor` (enum, required) — The property management system of record - Allowed values: `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `REALPAGE_RPX`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST` - `x_location_id` (string, required, nullable) — The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. - `unit_type_id` (string, required, nullable) — The Propexo unique identifier for the unit type - `street_address_1` (string, required, nullable, deprecated) — Deprecated: Use address_1 - `street_address_2` (string, required, nullable, deprecated) — Deprecated: Use address_2 ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### ResponseMetaOrderByItems ### ListingCustomData ## Examples **Request** ```json {} ``` **Response** ```json { "meta": { "orderBy": [ {} ], "offset": 0, "limit": 100, "hasMore": true, "total": 1000 }, "results": { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "created_at": "2024-05-10T09:15:00Z", "updated_at": "2024-06-01T12:00:00Z", "last_seen": "2024-06-01T11:45:00Z", "x_id": "EXT123456", "x_property_id": "PROP78910", "x_unit_id": "UNIT4567", "x_floor_plan_id": "FP1234", "is_unit": true, "available_date": "2024-07-01", "application_url": "https://apply.propexo.com/listing/a1b2c3d4", "bathrooms": "2.5", "bathrooms_full": 2, "bathrooms_half": 1, "bedrooms": "3", "building_name": "Sunset Towers", "building_number": "12B", "city": "San Francisco", "country": "USA", "custom_data": {}, "deposit_amount_in_cents": 150000, "floor_plan_code": "FP-3BR-2.5BA", "floor_plan_name": "Three Bedroom Deluxe", "floor": "5", "image_urls": [ "https://images.propexo.com/listings/a1b2c3d4/image1.jpg", "https://images.propexo.com/listings/a1b2c3d4/image2.jpg" ], "is_available": true, "is_furnished": false, "is_listed": true, "is_managed_external": false, "is_vacant": true, "lease_term": "12 months", "listing_title": "Spacious 3 Bedroom Apartment in Sunset Towers", "listing_date": "2024-05-10", "marketing_name": "Sunset 3BR Deluxe", "notes": "No pets allowed. Utilities included.", "number": "5B", "rent_amount_in_cents": 350000, "specials": "First month free rent", "square_feet": 1450, "state": "CA", "address_1": "1234 Market St", "address_2": "Unit 5B", "property_description": "Luxury apartment complex with pool and gym.", "short_description": "3BR, 2.5BA apartment with modern amenities.", "unit_description": "Corner unit with city views and balcony.", "zip": "94103", "make_ready_date": "2024-06-25", "vacate_date": null, "video_urls": [ "https://videos.propexo.com/listings/a1b2c3d4/tour.mp4" ], "status_raw": "active", "property_id": "prop-001234", "unit_id": "unit-00567", "floor_plan_id": "fp-00321", "integration_id": "int-7890", "integration_vendor": "APPFOLIO", "x_location_id": null, "unit_type_id": "ut-12345", "street_address_1": "1234 Market St", "street_address_2": "Unit 5B" } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/listings/listing_id" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/listings/listing_id'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.propexo.com/v1/listings/listing_id" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.propexo.com/v1/listings/listing_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.propexo.com/v1/listings/listing_id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.propexo.com/v1/listings/listing_id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/listings/listing_id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/listings/listing_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```