Get all service requests

GEThttps://api.propexo.com/v1/service-requests/

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 ID from the integration vendor

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

employee_id string

The Propexo unique identifier for the employee

vendor_id string

The Propexo unique identifier for the vendor

property_id string

The Propexo unique identifier for the property

integration_id string

The Propexo unique identifier for the integration

integration_vendor string

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The property management system of record

unit_number string

The unit number of the service request. When using this, the Propexo property_id filter must be added as well.

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 service request
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	Interface
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: 204418
x_property_idstringrequired
The external ID of the property from the integration vendor
Method	Interface
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: 4829103
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 REALPAGE_RPX
Example: null
x_unit_idstring | nullnullablerequired
The external ID of the unit from the integration vendor
Method	Interface
GetServiceRequest	Facilities
Example: 7192044
x_sub_task_idnullrequired
The external ID of the sub task from the integration vendor
Notice
This field will always be null for REALPAGE_RPX
Example: null
access_is_authorizedboolean | nullnullablerequired
Whether or not the tenant has granted permission to enter the unit associated with the service request
Method	Interface
GetServiceRequest	Facilities
Example: true
access_notesstring | nullnullablerequired
Notes regarding access to the unit associated with the service request
Important
This field includes the original entry notes from RealPage with the permission to enter status appended. Permission to enter values: '0' = Enter at Any Time, '1' = By Permission Only, '2' = Call for Entry
Method	Interface
GetServiceRequest	Facilities
Example: Please call before entering. Permission to enter: By Permission Only
buildingstring | nullnullablerequired
The building name associated with the service request
Method	Interface
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: 2
completion_notesstring | nullnullablerequired
Closing notes associated with the service request
Method	Interface
GetServiceRequest	Facilities
Example: Replaced the kitchen faucet cartridge
date_completedstring | nullnullablerequired
The date the service request was completed
Method	Interface
GetServiceRequest	Facilities
Example: 2024-06-18T15:30:00.000Z
date_createdstring | nullnullablerequired
The date the service request was created
Method	Interface
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: 2024-06-15T09:00:00.000Z
date_duestring | nullnullablerequired
The due date associated with the service request
Method	Interface
GetServiceRequest	Facilities
Example: 2024-06-20T17:00:00.000Z
date_scheduledstring | nullnullablerequired
The date the service request is scheduled
Method	Interface
GetWorkOrderSurveyList	Survey Interfaces
Example: 2024-06-17T10:00:00.000Z
notesstring | nullnullablerequireddeprecated
DEPRECATED: Please use 'history' for reading notes regarding the service request
Method	Interface
GetServiceRequest	Facilities
service_categorystring | nullnullablerequired
The category of service request
Method	Interface
GetServiceRequest	Facilities
Example: Plumbing
service_descriptionnullrequired
A description of the service request
Notice
This field will always be null for REALPAGE_RPX
Example: null
service_detailsstring | nullnullablerequired
Details about the service request
Method	Interface
GetServiceRequest	Facilities
Example: Kitchen faucet drips when the handle is turned off
service_prioritynullrequired
The priority level associated with the service request
Notice
This field will always be null for REALPAGE_RPX
Example: null
status_rawstring | nullnullablerequired
The raw status associated with the service request
Method	Interface
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: In progress
vendor_notesnullrequired
Vendor/technician notes associated with the service request
Notice
This field will always be null for REALPAGE_RPX
Example: null
unit_numberstring | nullnullablerequired
The unit number associated with the service request. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases.
Method	Interface
GetWorkOrderSurveyList	Survey Interfaces
Example: 100
order_numberstring | nullnullablerequired
The order number of the service request
Method	Interface
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: 2034-1
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum20required
The property management system of record
Show 13 enum values
REALPAGE_RPXAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGERENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: REALPAGE_RPX
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
unit_idstring | nullnullablerequired
The Propexo unique identifier for the unit
Method	Interface
GetServiceRequest	Facilities
Example: cm0rpx0001exampleid000001
employee_idstring | nullnullablerequired
The Propexo unique identifier for the employee
Method	Interface
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: cm0rpx0010exampleid000001
vendors object[]required
List of vendor IDs associated with the service request
Notice
This field is not currently hydrated for REALPAGE_RPX
Array [
vendor_idstringrequired
]
history object[]required
History of notes and/or updates related to the service request
Array [
idstringrequired
The Propexo unique identifier for the service request history
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_seenstringrequired
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	Interface
GetServiceRequest	Facilities
Example: cm0rpx0005exampleid000001
x_created_atstring | nullnullablerequired
The date the record first entered the integration vendor
Method	Interface
GetServiceRequest	Facilities
Example: 2024-06-15T09:15:00.000Z
notesstringrequired
Notes describing the service request history
Method	Interface
GetServiceRequest	Facilities
Example: Scheduled a visit for tomorrow morning
creator_namestring | nullnullablerequired
The name of the person or user that created the service request history
Method	Interface
GetServiceRequest	Facilities
Example: Alex Rivera
status_rawstring | nullnullablerequired
The raw status from the service request history
Method	Interface
GetServiceRequest	Facilities
Example: In progress
service_request_idstringrequired
The Propexo unique identifier for the service request
Method	Interface
GetServiceRequest	Facilities
Example: cm0rpx0009exampleid000001
]
employees object[]required
An array of all employees assigned to the service request
Array [
idstringrequired
The Propexo unique identifier for the employee
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	Interface
GetLeasingAgentsByProperty	Prospect Management
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: 640218
namestring | nullnullablerequired
The name associated with the employee
Method	Interface
GetLeasingAgentsByProperty	Prospect Management
GetServiceRequest	Facilities
GetWorkOrderSurveyList	Survey Interfaces
Example: Alex Rivera
]
]

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/service-requests/

curl https://api.propexo.com/v1/service-requests/ \
     -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": "204418",
      "x_property_id": "4829103",
      "x_location_id": null,
      "x_unit_id": "7192044",
      "x_sub_task_id": null,
      "access_is_authorized": true,
      "access_notes": "Please call before entering. Permission to enter: By Permission Only",
      "building": "2",
      "completion_notes": "Replaced the kitchen faucet cartridge",
      "date_completed": "2024-06-18T15:30:00.000Z",
      "date_created": "2024-06-15T09:00:00.000Z",
      "date_due": "2024-06-20T17:00:00.000Z",
      "date_scheduled": "2024-06-17T10:00:00.000Z",
      "service_category": "Plumbing",
      "service_description": null,
      "service_details": "Kitchen faucet drips when the handle is turned off",
      "service_priority": null,
      "status_raw": "In progress",
      "vendor_notes": null,
      "unit_number": "100",
      "order_number": "2034-1",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "REALPAGE_RPX",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "unit_id": "cm0rpx0001exampleid000001",
      "employee_id": "cm0rpx0010exampleid000001",
      "vendors": [
        {
          "vendor_id": "string"
        }
      ],
      "history": [
        {
          "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": "cm0rpx0005exampleid000001",
          "x_created_at": "2024-06-15T09:15:00.000Z",
          "notes": "Scheduled a visit for tomorrow morning",
          "creator_name": "Alex Rivera",
          "status_raw": "In progress",
          "service_request_id": "cm0rpx0009exampleid000001"
        }
      ],
      "employees": [
        {
          "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": "640218",
          "name": "Alex Rivera"
        }
      ]
    }
  ]
}