> 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 resident by ID GET https://api.propexo.com/v1/residents/{id} Get a resident by ID Reference: https://docs.propexo.com/api-reference/real-page-app-partner/residents/get-a-resident-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 - `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` (V1ResidentsIdGetOutputResults, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### ResponseMeta - `orderBy` (list of ResponseMetaOrderByItems, required) — The order of the results - `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 ### V1ResidentsIdGetOutputResults - `id` (string, required) — The Propexo unique identifier for the resident - `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 | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `address_1_alternate` (string, required, nullable) — The first alternate address line associated with the resident | Method | Interface | |---|---| | GetResidentConvergent | Convergent Billing | - `address_1` (string, required, nullable) — The first address line associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `address_2_alternate` (string, required, nullable) — The second alternate address line associated with the resident | Method | Interface | |---|---| | GetResidentConvergent | Convergent Billing | - `address_2` (string, required, nullable) — The second address line associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `balance_in_cents` (double, required, nullable) — The rent balance owed | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `city_alternate` (string, required, nullable) — The alternate city associated with the resident | Method | Interface | |---|---| | GetResidentConvergent | Convergent Billing | - `city` (string, required, nullable) — The city associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `country_alternate` (string, required, nullable) — The alternate country associated with the resident | Method | Interface | |---|---| | GetResidentConvergent | Convergent Billing | - `country` (string, required, nullable) — The country associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | - `custom_data` (V1ResidentsIdGetOutputResultsCustomData, required, nullable) - `date_of_birth` (string, required, nullable) — The date of birth associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `email_1` (string, required, nullable) — The primary email address associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `email_2` (string, required, nullable) — The secondary email address associated with the resident | Method | Interface | |---|---| | GetResidentConvergent | Convergent Billing | - `first_name` (string, required, nullable) — The first name associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `is_employee` (any, required) — Is the resident an employeeThis field will always be null for REALPAGE\_RPX - `last_name` (string, required, nullable) — The last name associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `late_balance_in_cents` (any, required) — The past due rent balance owedThis field will always be null for REALPAGE\_RPX - `middle_name` (any, required) — The middle name associated with the residentThis field will always be null for REALPAGE\_RPX - `notes` (any, required) — Notes associated with the residentThis field will always be null for REALPAGE\_RPX - `phone_1_type` (enum, required) — Type of the primary phone number | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - Allowed values: `FAX`, `HOME`, `MOBILE`, `OTHER`, `WORK` - `phone_1` (string, required, nullable) — Primary phone number associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentSurveyList | Survey Interfaces | - `phone_2_type` (enum, required) — Type of the secondary phone number | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - Allowed values: `FAX`, `HOME`, `MOBILE`, `OTHER`, `WORK` - `phone_2` (string, required, nullable) — Secondary phone number associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `state_alternate` (string, required, nullable) — The alternate state associated with the resident | Method | Interface | |---|---| | GetResidentConvergent | Convergent Billing | - `state` (string, required, nullable) — The state associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `zip_alternate` (string, required, nullable) — The alternate zip code associated with the resident | Method | Interface | |---|---| | GetResidentConvergent | Convergent Billing | - `zip` (string, required, nullable) — The zip code associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | | GetResidentConvergent | Convergent Billing | | GetResidentSurveyList | Survey Interfaces | - `pets` (list of V1ResidentsIdGetOutputResultsPetsItems, required) — This field is not currently hydrated for REALPAGE_RPX - `vehicles` (list of V1ResidentsIdGetOutputResultsVehiclesItems, required) — This field is not currently hydrated for REALPAGE_RPX - `integration_id` (string, required) — The Propexo unique identifier for the integration - `integration_vendor` (enum, required) — The property management system of record - Allowed values: `REALPAGE_RPX`, `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST` - `property_id` (string, required) — The Propexo unique identifier for the property - `x_lease_id` (string, required, nullable, deprecated) — Deprecated. Use leases_meta_data instead | Method | Interface | |---|---| | GetResidentConvergent | Convergent Billing | - `leases_meta_data` (list of V1ResidentsIdGetOutputResultsLeasesMetaDataItems, optional) — Known associated lease meta data ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### ResponseMetaOrderByItems ### V1ResidentsIdGetOutputResultsCustomData ### V1ResidentsIdGetOutputResultsPetsItems - `id` (string, required) — The Propexo unique identifier for the resident pet - `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 - `name` (string, required, nullable) — The name associated with the resident petThis field is not currently hydrated for REALPAGE\_RPX - `type` (string, required, nullable) — The type associated with the resident petThis field is not currently hydrated for REALPAGE\_RPX - `breed` (string, required, nullable) — The breed of the resident petThis field is not currently hydrated for REALPAGE\_RPX - `gender_raw` (string, required, nullable) — The raw value for the gender of the resident petThis field is not currently hydrated for REALPAGE\_RPX - `age_in_years` (double, required, nullable) — The age in years of the resident petThis field is not currently hydrated for REALPAGE\_RPX - `weight_in_pounds` (double, required, nullable) — The weight in pounds of the resident petThis field is not currently hydrated for REALPAGE\_RPX - `is_fixed` (boolean, required, nullable) — Whether the resident pet is fixedThis field is not currently hydrated for REALPAGE\_RPX - `is_service_animal` (boolean, required, nullable) — Whether the resident pet is a service animalThis field is not currently hydrated for REALPAGE\_RPX - `notes` (string, required, nullable) — Notes associated with the resident petThis field is not currently hydrated for REALPAGE\_RPX - `custom_data` (V1ResidentsIdGetOutputResultsPetsItemsCustomData, required, nullable) ### V1ResidentsIdGetOutputResultsVehiclesItems - `id` (string, required) — The Propexo unique identifier for the resident vehicle - `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 - `make` (string, required, nullable) — The make of the resident vehicleThis field is not currently hydrated for REALPAGE\_RPX - `model` (string, required, nullable) — The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicleThis field is not currently hydrated for REALPAGE\_RPX - `color` (string, required, nullable) — The color of the resident vehicleThis field is not currently hydrated for REALPAGE\_RPX - `year` (string, required, nullable) — The year of the resident vehicleThis field is not currently hydrated for REALPAGE\_RPX - `license_plate_number` (string, required, nullable) — The license plate number of the resident vehicleThis field is not currently hydrated for REALPAGE\_RPX - `license_plate_state` (string, required, nullable) — The license plate state of the resident vehicleThis field is not currently hydrated for REALPAGE\_RPX - `notes` (string, required, nullable) — Notes associated with the resident vehicleThis field is not currently hydrated for REALPAGE\_RPX - `custom_data` (V1ResidentsIdGetOutputResultsVehiclesItemsCustomData, required, nullable) ### V1ResidentsIdGetOutputResultsLeasesMetaDataItems - `lease_id` (string, required) — The Propexo unique identifier for the lease | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `x_resident_type` (string, required, nullable) — The external type of the resident from the integration vendor | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `resident_type_normalized` (V1ResidentsIdGetOutputResultsLeasesMetaDataItemsResidentTypeNormalized, required, nullable) — Resident type from Propexo | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `move_in_date` (string, required, nullable) — The move-in date associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `move_out_date` (string, required, nullable) — The move-out date associated with the resident | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `notice_date` (string, required, nullable) — The date the resident gave notice | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | - `custom_data` (V1ResidentsIdGetOutputResultsLeasesMetaDataItemsCustomData, required, nullable) - `last_seen` (string, required, nullable) — The date the record was last seen from the PMS ### V1ResidentsIdGetOutputResultsPetsItemsCustomData ### V1ResidentsIdGetOutputResultsVehiclesItemsCustomData ### V1ResidentsIdGetOutputResultsLeasesMetaDataItemsResidentTypeNormalized Resident type from Propexo | Method | Interface | |---|---| | GetResidentListInfo | Resident Management | ### V1ResidentsIdGetOutputResultsLeasesMetaDataItemsCustomData ## Examples **Request** ```json {} ``` **Response** ```json { "meta": { "orderBy": [ {} ], "offset": 0, "limit": 100, "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": "9876543210", "address_1_alternate": null, "address_1": "123 Main St", "address_2_alternate": null, "address_2": "Apt 1B", "balance_in_cents": 125000, "city_alternate": null, "city": "New York", "country_alternate": null, "country": "US", "custom_data": {}, "date_of_birth": "1985-07-15T00:00:00.000Z", "email_1": "john.doe@example.com", "email_2": "j.doe@workmail.com", "first_name": "John", "is_employee": null, "last_name": "Doe", "late_balance_in_cents": null, "middle_name": null, "notes": null, "phone_1_type": "MOBILE", "phone_1": "2125551234", "phone_2_type": "WORK", "phone_2": "2125555678", "state_alternate": null, "state": "NY", "zip_alternate": null, "zip": "10001", "pets": [ { "id": "clwktsp9v000008l31iv218hp", "created_at": "2023-06-10T12:00:00.000Z", "updated_at": "2024-03-20T09:30:00.000Z", "last_seen": "2024-03-22T10:59:45.119Z", "x_id": "pet12345", "name": "Buddy", "type": "Dog", "breed": "Golden Retriever", "gender_raw": "Male", "age_in_years": 3.5, "weight_in_pounds": 65, "is_fixed": true, "is_service_animal": false, "notes": "Friendly and well-trained", "custom_data": {} } ], "vehicles": [ { "id": "clwktsp9v000008l31iv218hq", "created_at": "2022-08-15T08:00:00.000Z", "updated_at": "2024-01-10T14:45:00.000Z", "last_seen": "2024-03-22T10:59:45.119Z", "x_id": "veh67890", "make": "Toyota", "model": "Camry", "color": "Blue", "year": "2018", "license_plate_number": "ABC1234", "license_plate_state": "NY", "notes": "Parked in spot 42", "custom_data": {} } ], "integration_id": "clwh5u07w000508me66sfh3um", "integration_vendor": "REALPAGE_RPX", "property_id": "clwi5xiix000008l6ctdgafyh", "x_lease_id": null, "leases_meta_data": [ { "lease_id": "clwktsp9v000009m41jv219xy", "x_resident_type": "Primary Tenant", "resident_type_normalized": "PRIMARY", "move_in_date": "2023-05-01T00:00:00.000Z", "move_out_date": null, "notice_date": null, "custom_data": {}, "last_seen": "2024-03-22T10:59:45.119Z" } ] } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/residents/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/residents/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/residents/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/residents/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/residents/id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.propexo.com/v1/residents/id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/residents/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/residents/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() ```