> 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 all residents GET https://api.propexo.com/v1/residents/ Get all residents Reference: https://docs.propexo.com/api-reference/pms-generic-ap-is/residents/get-all-residents ## 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 ### 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 - `x_id` (string, optional) — The external resident id - `x_property_id` (string, optional) — Deprecated: Use Propexo property_id instead - `location_id` (string, optional) — 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, optional) — The Propexo property id - `lease_id` (string, optional) — The Propexo lease id - `integration_id` (string, optional) — The Propexo integration id - `integration_vendor` (enum, optional) — The integration vendor for the resident. - Allowed values: `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `REALPAGE_RPX`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST` - `email_1` (string, optional) — The primary email address associated with the resident - `phone_1` (string, optional) — Filter by phone number (10 digit format only) ## Response ### 200 Successful response - `meta` (ResponseMeta, required) - `results` (list of V1ResidentsGetOutputResultsItems, 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 ### V1ResidentsGetOutputResultsItems - `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 - `address_1_alternate` (string, required, nullable) — The first alternate address line associated with the resident - `address_1` (string, required, nullable) — The first address line associated with the resident - `address_2_alternate` (string, required, nullable) — The second alternate address line associated with the resident - `address_2` (string, required, nullable) — The second address line associated with the resident - `balance_in_cents` (double, required, nullable) — The rent balance owed - `city_alternate` (string, required, nullable) — The alternate city associated with the resident - `city` (string, required, nullable) — The city associated with the resident - `country_alternate` (string, required, nullable) — The alternate country associated with the resident - `country` (string, required, nullable) — The country associated with the resident - `custom_data` (V1ResidentsGetOutputResultsItemsCustomData, required, nullable) - `date_of_birth` (string, required, nullable) — The date of birth associated with the resident - `email_1` (string, required, nullable) — The primary email address associated with the resident - `email_2` (string, required, nullable) — The secondary email address associated with the resident - `first_name` (string, required, nullable) — The first name associated with the resident - `is_employee` (boolean, required, nullable) — Is the resident an employee - `last_name` (string, required, nullable) — The last name associated with the resident - `late_balance_in_cents` (double, required, nullable) — The past due rent balance owed - `middle_name` (string, required, nullable) — The middle name associated with the resident - `notes` (string, required, nullable) — Notes associated with the resident - `phone_1_type` (enum, required) — Type of the primary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `OTHER`, `WORK` - `phone_1` (string, required, nullable) — Primary phone number associated with the resident - `phone_2_type` (enum, required) — Type of the secondary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `OTHER`, `WORK` - `phone_2` (string, required, nullable) — Secondary phone number associated with the resident - `state_alternate` (string, required, nullable) — The alternate state associated with the resident - `state` (string, required, nullable) — The state associated with the resident - `zip_alternate` (string, required, nullable) — The alternate zip code associated with the resident - `zip` (string, required, nullable) — The zip code associated with the resident - `pets` (list of V1ResidentsGetOutputResultsItemsPetsItems, required) - `vehicles` (list of V1ResidentsGetOutputResultsItemsVehiclesItems, required) - `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` - `property_id` (string, required) — The Propexo unique identifier for the property - `x_lease_id` (string, required, nullable, deprecated) — Deprecated. Use leases_meta_data instead - `leases_meta_data` (list of V1ResidentsGetOutputResultsItemsLeasesMetaDataItems, optional) ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### ResponseMetaOrderByItems ### V1ResidentsGetOutputResultsItemsCustomData ### V1ResidentsGetOutputResultsItemsPetsItems - `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 pet - `type` (string, required, nullable) — The type associated with the resident pet - `breed` (string, required, nullable) — The breed of the resident pet - `gender_raw` (string, required, nullable) — The raw value for the gender of the resident pet - `age_in_years` (double, required, nullable) — The age in years of the resident pet - `weight_in_pounds` (double, required, nullable) — The weight in pounds of the resident pet - `is_fixed` (boolean, required, nullable) — Whether the resident pet is fixed - `is_service_animal` (boolean, required, nullable) — Whether the resident pet is a service animal - `notes` (string, required, nullable) — Notes associated with the resident pet - `custom_data` (V1ResidentsGetOutputResultsItemsPetsItemsCustomData, required, nullable) ### V1ResidentsGetOutputResultsItemsVehiclesItems - `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 vehicle - `model` (string, required, nullable) — The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle - `color` (string, required, nullable) — The color of the resident vehicle - `year` (string, required, nullable) — The year of the resident vehicle - `license_plate_number` (string, required, nullable) — The license plate number of the resident vehicle - `license_plate_state` (string, required, nullable) — The license plate state of the resident vehicle - `notes` (string, required, nullable) — Notes associated with the resident vehicle - `custom_data` (V1ResidentsGetOutputResultsItemsVehiclesItemsCustomData, required, nullable) ### V1ResidentsGetOutputResultsItemsLeasesMetaDataItems - `lease_id` (string, required) — The Propexo unique identifier for the lease - `x_resident_type` (string, required, nullable) — The external type of the resident from the integration vendor - `resident_type_normalized` (V1ResidentsGetOutputResultsItemsLeasesMetaDataItemsResidentTypeNormalized, required, nullable) — Resident type from Propexo - `move_in_date` (string, required, nullable) — The move-in date associated with the resident - `move_out_date` (string, required, nullable) — The move-out date associated with the resident - `notice_date` (string, required, nullable) — The date the resident gave notice - `custom_data` (V1ResidentsGetOutputResultsItemsLeasesMetaDataItemsCustomData, required, nullable) - `last_seen` (string, required, nullable) — The date the record was last seen from the PMS ### V1ResidentsGetOutputResultsItemsPetsItemsCustomData ### V1ResidentsGetOutputResultsItemsVehiclesItemsCustomData ### V1ResidentsGetOutputResultsItemsLeasesMetaDataItemsResidentTypeNormalized Resident type from Propexo ### V1ResidentsGetOutputResultsItemsLeasesMetaDataItemsCustomData ## Examples **Request** ```json {} ``` **Response** ```json { "meta": { "orderBy": [ {} ], "offset": 0, "limit": 100, "hasMore": true, "total": 1000 }, "results": [ { "id": "res-9f8b7c6d-1234-4a56-b789-0a1b2c3d4e5f", "created_at": "2023-11-15T09:30:00Z", "updated_at": "2024-05-20T14:45:00Z", "last_seen": "2024-05-19T18:00:00Z", "x_id": "EXT123456789", "address_1_alternate": "123 Maple St Apt 2B", "address_1": "456 Oak Avenue", "address_2_alternate": "Unit 2B", "address_2": "Building 5", "balance_in_cents": 125000, "city_alternate": "Springfield", "city": "Greenville", "country_alternate": "USA", "country": "USA", "custom_data": {}, "date_of_birth": "1985-04-12", "email_1": "jane.doe@example.com", "email_2": "jane.alt@example.com", "first_name": "Jane", "is_employee": false, "last_name": "Doe", "late_balance_in_cents": 25000, "middle_name": "A", "notes": "Prefers email communication. Allergic to cats.", "phone_1_type": "MOBILE", "phone_1": "2125557890", "phone_2_type": "WORK", "phone_2": "2125551234", "state_alternate": "IL", "state": "NY", "zip_alternate": "62704", "zip": "10001", "pets": [ { "id": "pet-7c6d5e4f-2345-4b67-c890-1a2b3c4d5e6f", "created_at": "2023-01-10T11:00:00Z", "updated_at": "2024-04-15T10:00:00Z", "last_seen": "2024-05-18T16:00:00Z", "x_id": "PET987654321", "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": "veh-1a2b3c4d-3456-4c78-d901-2b3c4d5e6f7a", "created_at": "2022-08-20T08:30:00Z", "updated_at": "2024-03-10T09:15:00Z", "last_seen": "2024-05-17T12:00:00Z", "x_id": "VEH123456789", "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": "int-5d4c3b2a-6789-4e01-f234-5a6b7c8d9e0f", "integration_vendor": "APPFOLIO", "property_id": "prop-1234abcd-5678-ef90-gh12-ijkl3456mnop", "x_lease_id": null, "leases_meta_data": [ { "lease_id": "lease-4a3b2c1d-5678-4e90-b123-4f5e6d7c8b9a", "x_resident_type": "Primary Tenant", "resident_type_normalized": "PRIMARY", "move_in_date": "2022-06-01", "move_out_date": null, "notice_date": null, "custom_data": {}, "last_seen": "2024-05-19T18:00:00Z" } ] } ] } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/residents/" 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/'; 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/" 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/") 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/") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.propexo.com/v1/residents/', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/residents/"); 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/")! 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() ```