For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
How It WorksKnowledge BaseOnboardingVideo TutorialsPMS GuidanceAPI ReferenceRelease Notes
    • Overview
    • PMS Generic APIs
    • CRM Generic APIs
    • PMS APIs
        • GETGet all service requests
        • GETGet a service request by ID
        • GETGet all service request history
        • GETGet service request history by ID
        • PUTUpdate Service Request: Propertyware
        • POSTCreate Service Request: Propertyware
        • POSTCreate Service Request History: Propertyware
        • POSTCreate Service Request File: Propertyware
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
Propertyware SOAPService Requests

Get a service request by ID

GET
/v1/service-requests/:service_request_id
GET
/v1/service-requests/:service_request_id
$curl https://api.propexo.com/v1/service-requests/service_request_id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "meta": {
3    "orderBy": [
4      {}
5    ],
6    "offset": 0,
7    "limit": 100,
8    "hasMore": true,
9    "total": 1000
10  },
11  "results": {
12    "access_is_authorized": null,
13    "access_notes": null,
14    "building": null,
15    "completion_notes": null,
16    "created_at": "2024-03-21T15:38:08.337Z",
17    "date_completed": "2024-03-25T16:00:00Z",
18    "date_created": "2024-03-20T09:15:00Z",
19    "date_due": "2024-03-24T17:00:00Z",
20    "date_scheduled": "2024-03-23T10:00:00Z",
21    "employee_id": null,
22    "employees": [
23      {
24        "id": "clwktsp9v000008l31iv218hn",
25        "created_at": "2024-03-21T15:38:08.337Z",
26        "updated_at": "2024-03-22T10:59:45.119Z",
27        "last_seen": "2024-03-22T10:59:45.119Z",
28        "x_id": "EMP-56789",
29        "name": "John Doe"
30      }
31    ],
32    "history": [
33      {
34        "id": "clwktsp9v000008l31iv218hn",
35        "created_at": "2024-03-21T15:38:08.337Z",
36        "updated_at": "2024-03-22T10:59:45.119Z",
37        "last_seen": "2024-03-22T10:59:45.119Z",
38        "x_id": "PW-HIST-001",
39        "x_created_at": "2024-03-21T16:00:00Z",
40        "notes": "Initial request logged by tenant.",
41        "creator_name": null,
42        "status_raw": null,
43        "service_request_id": "clwktsp9v000008l31iv218hn"
44      }
45    ],
46    "id": "clwktsp9v000008l31iv218hn",
47    "integration_id": "clwh5u07w000508me66sfh3um",
48    "integration_vendor": "PROPERTYWARE",
49    "last_seen": "2024-03-22T10:59:45.119Z",
50    "order_number": "41",
51    "property_id": "clwi5xiix000008l6ctdgafyh",
52    "service_category": "Plumbing",
53    "service_description": "Fix leaking kitchen faucet",
54    "service_details": null,
55    "service_priority": null,
56    "status_raw": "In Progress",
57    "unit_id": "clwi5xunit000008l6ctdgu123",
58    "unit_number": null,
59    "updated_at": "2024-03-22T10:59:45.119Z",
60    "vendor_notes": null,
61    "vendors": [
62      {
63        "vendor_id": "vendor-12345"
64      }
65    ],
66    "x_id": "PW-987654321",
67    "x_location_id": null,
68    "x_property_id": "PW-PROP-123456",
69    "x_sub_task_id": null,
70    "x_unit_id": "UNIT-101",
71    "notes": null
72  }
73}
Get a service request by ID
Was this page helpful?
Previous

Get all service request history

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

service_request_idstringRequired
The ID of the resource.

Query parameters

order-bystringOptionalDefaults to 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

offsetinteger or nullOptional>=0Defaults to 0
Can be used for paginating results
limitinteger or nullOptional0-250Defaults to 100
A number between 1 and 250 to determine the number of results to return in a single query

Response

Successful response
metaobject
resultsobject

Errors

400
Bad Request Error