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	/WorkOrders/GetWorkOrders

Example: 208c7792-19cb-4653-893c-6714458f5009

x_property_idstringrequired

The external ID of the property from the integration vendor

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: 6b578f0f-52c8-4cdb-9283-d8d822e1133c

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 RESMAN

Example: null

x_unit_idnullrequired

The external ID of the unit from the integration vendor

Notice

This field will always be null for RESMAN

Example: null

x_sub_task_idnullrequired

The external ID of the sub task from the integration vendor

Notice

This field will always be null for RESMAN

Example: null

access_is_authorizednullrequired

Whether or not the tenant has granted permission to enter the unit associated with the service request

Notice

This field will always be null for RESMAN

Example: null

access_notesnullrequired

Notes regarding access to the unit associated with the service request

Notice

This field will always be null for RESMAN

Example: null

buildingnullrequired

The building name associated with the service request

Notice

This field will always be null for RESMAN

Example: null

completion_notesstring | nullnullablerequired

Closing notes associated with the service request

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: Replaced old pipe with PVC.

date_completedstring | nullnullablerequired

The date the service request was completed

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: 2024-02-01T00:00:00.000Z

date_createdstring | nullnullablerequired

The date the service request was created

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: 2024-02-15T00:00:00.000Z

date_duestring | nullnullablerequired

The due date associated with the service request

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: 2024-02-17T00:00:00.000Z

date_schedulednullrequired

The date the service request is scheduled

Notice

This field will always be null for RESMAN

Example: null

notesnullrequireddeprecated

DEPRECATED: Please use 'history' for reading notes regarding the service request

Notice

This field will always be null for RESMAN

Example: null

service_categorystring | nullnullablerequired

The category of service request

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: Broken Blinds

service_descriptionstring | nullnullablerequired

A description of the service request

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: Previous lease must have broken the blinds. They need to be replaced.

service_detailsstring | nullnullablerequired

Details about the service request

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: Needs 37 inch blinds in egg shell color.

service_prioritystring | nullnullablerequired

The priority level associated with the service request

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: Medium

status_rawstring | nullnullablerequired

The raw status associated with the service request

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: Completed

vendor_notesnullrequired

Vendor/technician notes associated with the service request

Notice

This field will always be null for RESMAN

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.

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: 1102

order_numberstring | nullnullablerequired

The order number of the service request

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: 1

integration_idstringrequired

The Propexo unique identifier for the integration

Example: clwh5u07w000508me66sfh3um

integration_vendorEnum23required

The property management system of record

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

Example: RESMAN

property_idstringrequired

The Propexo unique identifier for the property

Example: clwi5xiix000008l6ctdgafyh

unit_idnullrequired

The Propexo unique identifier for the unit

Notice

This field will always be null for RESMAN

Example: null

employee_idstring | nullnullablerequired

The Propexo unique identifier for the employee

Interface	Method
Work Orders	/WorkOrders/GetWorkOrders

Example: cm20wwnse57896015aniou4f75lmz

vendors object[]required

List of vendor IDs associated with the service request

Notice

This field is not currently hydrated for RESMAN

Array [

vendor_idstringrequired

Notice

This field is not currently hydrated for RESMAN

]

history object[]required

History of notes and/or updates related to the service request

Notice

This field is not currently hydrated for RESMAN

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

x_created_atstring | nullnullablerequired

The date the record first entered the integration vendor

Notice

This field is not currently hydrated for RESMAN

notesstringrequired

Notes describing the service request history

Notice

This field is not currently hydrated for RESMAN

creator_namestring | nullnullablerequired

The name of the person or user that created the service request history

Notice

This field is not currently hydrated for RESMAN

status_rawstring | nullnullablerequired

The raw status from the service request history

Notice

This field is not currently hydrated for RESMAN

service_request_idstringrequired

The Propexo unique identifier for the service request

]

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
Leasing	/Leasing/GetEmployees
Lead Management	/MITS/SearchProspects
Work Orders	/WorkOrders/GetWorkOrders

Example: c1d4e8a2-5f63-4b90-8c17-2e9a6d4b0f38

namestring | nullnullablerequired

The name associated with the employee

Interface	Method
Leasing	/Leasing/GetEmployees
Lead Management	/MITS/SearchProspects
Work Orders	/WorkOrders/GetWorkOrders

Example: John Wick

]

Errors

400Bad Request

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": "208c7792-19cb-4653-893c-6714458f5009",
    "x_property_id": "6b578f0f-52c8-4cdb-9283-d8d822e1133c",
    "x_location_id": null,
    "x_unit_id": null,
    "x_sub_task_id": null,
    "access_is_authorized": null,
    "access_notes": null,
    "building": null,
    "completion_notes": "Replaced old pipe with PVC.",
    "date_completed": "2024-02-01T00:00:00.000Z",
    "date_created": "2024-02-15T00:00:00.000Z",
    "date_due": "2024-02-17T00:00:00.000Z",
    "date_scheduled": null,
    "service_category": "Broken Blinds",
    "service_description": "Previous lease must have broken the blinds. They need to be replaced.",
    "service_details": "Needs 37 inch blinds in egg shell color.",
    "service_priority": "Medium",
    "status_raw": "Completed",
    "vendor_notes": null,
    "unit_number": "1102",
    "order_number": "1",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "RESMAN",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "unit_id": null,
    "employee_id": "cm20wwnse57896015aniou4f75lmz",
    "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": "string",
        "x_created_at": "string",
        "notes": "string",
        "creator_name": "string",
        "status_raw": "string",
        "service_request_id": "string"
      }
    ],
    "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": "c1d4e8a2-5f63-4b90-8c17-2e9a6d4b0f38",
        "name": "John Wick"
      }
    ]
  }
}

Get a service request by ID

Authentication​

Path parameters​

Query parameters​

Response​

Errors​

Authentication

Path parameters

Query parameters

Response

Errors