Get a service request by ID

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

Authentication

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

Path parameters

service_request_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 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
Interface	Method
Work Orders	GET /workorders
Example: cl9b1nqwe0014jsxq8ab1c2an
x_property_idstringrequired
The external ID of the property from the integration vendor
Interface	Method
Work Orders	GET /workorders
Example: cl9b1nqwe0001jsxq8ab1c2aa
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 BUILDIUM
Example: null
x_unit_idstring | nullnullablerequired
The external ID of the unit from the integration vendor
Interface	Method
Work Orders	GET /workorders
Example: cl9b1nqwe0002jsxq8ab1c2ab
x_sub_task_idstring | nullnullablerequired
The external ID of the sub task from the integration vendor
Interface	Method
Work Orders	GET /workorders
Example: cl9b1nqwe0019jsxq8ab1c2as
access_is_authorizedboolean | nullnullablerequired
Whether or not the tenant has granted permission to enter the unit associated with the service request
Interface	Method
Work Orders	GET /workorders
Example: true
access_notesstring | nullnullablerequired
Notes regarding access to the unit associated with the service request
Interface	Method
Work Orders	GET /workorders
Example: Call the resident before entry
buildingnullrequired
The building name associated with the service request
Notice
This field will always be null for BUILDIUM
Example: null
completion_notesnullrequired
Closing notes associated with the service request
Notice
This field will always be null for BUILDIUM
Example: null
date_completednullrequired
The date the service request was completed
Notice
This field will always be null for BUILDIUM
Example: null
date_creatednullrequired
The date the service request was created
Notice
This field will always be null for BUILDIUM
Example: null
date_duestring | nullnullablerequired
The due date associated with the service request
Interface	Method
Work Orders	GET /workorders
Example: 2024-06-20T00:00:00.000Z
date_schedulednullrequired
The date the service request is scheduled
Notice
This field will always be null for BUILDIUM
Example: null
notesstring | nullnullablerequireddeprecated
DEPRECATED: Please use 'history' for reading notes regarding the service request
Interface	Method
Work Orders	GET /workorders
service_categorynullrequired
The category of service request
Notice
This field will always be null for BUILDIUM
Example: null
service_descriptionstring | nullnullablerequired
A description of the service request
Interface	Method
Work Orders	GET /workorders
Example: Kitchen sink is leaking
service_detailsstring | nullnullablerequired
Details about the service request
Interface	Method
Work Orders	GET /workorders
Example: Water pools under the cabinet when the faucet runs
service_prioritystring | nullnullablerequired
The priority level associated with the service request
Interface	Method
Work Orders	GET /workorders
Example: Normal
status_rawstring | nullnullablerequired
The raw status associated with the service request
Interface	Method
Work Orders	GET /workorders
Example: InProgress
vendor_notesstring | nullnullablerequired
Vendor/technician notes associated with the service request
Interface	Method
Work Orders	GET /workorders
Example: Shutoff valve is behind the dishwasher
unit_numbernullrequired
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.
Notice
This field will always be null for BUILDIUM
Example: null
order_numberstring | nullnullablerequired
The order number of the service request
Interface	Method
Work Orders	GET /workorders
Example: 123BNE456K7
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum14required
The property management system of record
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: BUILDIUM
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
unit_idstring | nullnullablerequired
The Propexo unique identifier for the unit
Interface	Method
Work Orders	GET /workorders
Example: cl9b1nqwe0002jsxq8ab1c2ab
employee_idnullrequired
The Propexo unique identifier for the employee
Notice
This field will always be null for BUILDIUM
Example: null
vendors object[]required
List of vendor IDs associated with the service request
Notice
This field is not currently hydrated for BUILDIUM
Array [
vendor_idstringrequired
Notice
This field is not currently hydrated for BUILDIUM
]
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
Interface	Method
Tasks	GET /tasks/:taskId/history
Example: cl9b1nqwe0016jsxq8ab1c2ap
x_created_atstring | nullnullablerequired
The date the record first entered the integration vendor
Interface	Method
Tasks	GET /tasks/:taskId/history
Example: 2024-06-12T09:15:00.000Z
notesstringrequired
Notes describing the service request history
Interface	Method
Tasks	GET /tasks/:taskId/history
Example: Marked the request in progress after speaking with the resident
creator_namestring | nullnullablerequired
The name of the person or user that created the service request history
Interface	Method
Tasks	GET /tasks/:taskId/history
Example: Jordan Hale
status_rawstring | nullnullablerequired
The raw status from the service request history
Interface	Method
Tasks	GET /tasks/:taskId/history
Example: InProgress
service_request_idstringrequired
The Propexo unique identifier for the service request
Interface	Method
Tasks	GET /tasks/:taskId/history
Example: cl9b1nqwe0014jsxq8ab1c2an
]
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
Interface	Method
Administration	GET /users
Example: cl9b1nqwe0008jsxq8ab1c2ah
namestring | nullnullablerequired
The name associated with the employee
Interface	Method
Administration	GET /users
Example: Jordan Hale
]

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/:service_request_id

curl https://api.propexo.com/v1/service-requests/:service_request_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": "cl9b1nqwe0014jsxq8ab1c2an",
    "x_property_id": "cl9b1nqwe0001jsxq8ab1c2aa",
    "x_location_id": null,
    "x_unit_id": "cl9b1nqwe0002jsxq8ab1c2ab",
    "x_sub_task_id": "cl9b1nqwe0019jsxq8ab1c2as",
    "access_is_authorized": true,
    "access_notes": "Call the resident before entry",
    "building": null,
    "completion_notes": null,
    "date_completed": null,
    "date_created": null,
    "date_due": "2024-06-20T00:00:00.000Z",
    "date_scheduled": null,
    "service_category": null,
    "service_description": "Kitchen sink is leaking",
    "service_details": "Water pools under the cabinet when the faucet runs",
    "service_priority": "Normal",
    "status_raw": "InProgress",
    "vendor_notes": "Shutoff valve is behind the dishwasher",
    "unit_number": null,
    "order_number": "123BNE456K7",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "BUILDIUM",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "unit_id": "cl9b1nqwe0002jsxq8ab1c2ab",
    "employee_id": null,
    "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": "cl9b1nqwe0016jsxq8ab1c2ap",
        "x_created_at": "2024-06-12T09:15:00.000Z",
        "notes": "Marked the request in progress after speaking with the resident",
        "creator_name": "Jordan Hale",
        "status_raw": "InProgress",
        "service_request_id": "cl9b1nqwe0014jsxq8ab1c2an"
      }
    ],
    "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": "cl9b1nqwe0008jsxq8ab1c2ah",
        "name": "Jordan Hale"
      }
    ]
  }
}