Get an owner by ID

GEThttps://api.propexo.com/v1/owners/:owner_id

Authentication

• AuthorizationBearer
  Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

owner_id stringrequired

The ID of the resource.

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

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 objectrequired
idstringrequired
The Propexo unique identifier for the owner
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
getAllPortfolios
Example: 78912890
x_property_idstringrequired
The external ID of the property from the integration vendor
Method
getAllPortfolios
Example: na
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 PROPERTYWARE
Example: null
address_1string | nullnullablerequired
The first address line associated with the owner
Method
getAllPortfolios
Example: 122 Bay Avenue
address_2string | nullnullablerequired
The second address line associated with the owner
Method
getAllPortfolios
Example: Suite 3
citystring | nullnullablerequired
The city associated with the owner
Method
getAllPortfolios
Example: San Francisco
countrystring | nullnullablerequired
The country associated with the owner
Method
getAllPortfolios
Example: USA
statestring | nullnullablerequired
The state associated with the owner
Method
getAllPortfolios
Example: CA
zipstring | nullnullablerequired
The zip code associated with the owner
Method
getAllPortfolios
Example: 12374
first_namestring | nullnullablerequired
The first name associated with the owner
Important
This is the owner's first name that's stored in Propertware. This is not neccessarily the same as the "nameOnCheck" field from Propertyware. Contact support if you'd like the "nameOnCheck" field.
Method
getAllPortfolios
Example: John
middle_namenullrequired
The middle name associated with the owner
Notice
This field will always be null for PROPERTYWARE
Example: null
last_namestring | nullnullablerequired
The last name associated with the owner
Method
getAllPortfolios
Example: Doe
company_namestring | nullnullablerequired
The name of the company associated with the owner
Method
getAllPortfolios
Example: John's Property Management Co
notesnullrequired
Notes associated with the owner
Notice
This field will always be null for PROPERTYWARE
Example: null
email_1string | nullnullablerequired
The primary email address associated with the owner
Method
getAllPortfolios
Example: [email protected]
email_2nullrequired
The secondary email address associated with the owner
Notice
This field will always be null for PROPERTYWARE
Example: null
phone_1string | nullnullablerequired
Primary phone number associated with the owner
Method
getAllPortfolios
Example: (555) 555-5555
phone_1_typestring | nullnullablerequired
Type of the primary phone number
Method
getAllPortfolios
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
Example: MOBILE
phone_2string | nullnullablerequired
Secondary phone number associated with the owner
Method
getAllPortfolios
Example: (555) 555-5554
phone_2_typestring | nullnullablerequired
Type of the secondary phone number
Method
getAllPortfolios
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
Example: HOME
associated_property_idsstring[]required
The property IDs associated with the owner
Method
getBuildingsForPortfolio
Example: cm22ciaag4068540708shp6tp1a0gtdj
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum17required
The property management system of record
Show 13 enum values
PROPERTYWAREAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: PROPERTYWARE
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh

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/owners/:owner_id

curl https://api.propexo.com/v1/owners/:owner_id \
     -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": "78912890",
    "x_property_id": "na",
    "x_location_id": null,
    "address_1": "122 Bay Avenue",
    "address_2": "Suite 3",
    "city": "San Francisco",
    "country": "USA",
    "state": "CA",
    "zip": "12374",
    "first_name": "John",
    "middle_name": null,
    "last_name": "Doe",
    "company_name": "John's Property Management Co",
    "notes": null,
    "email_1": "[email protected]",
    "email_2": null,
    "phone_1": "(555) 555-5555",
    "phone_1_type": "MOBILE",
    "phone_2": "(555) 555-5554",
    "phone_2_type": "HOME",
    "associated_property_ids": "cm22ciaag4068540708shp6tp1a0gtdj",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "PROPERTYWARE",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}