List work orders with note summaries

GET

/api/work-orders

curl --request GET \
  --url 'https://api.getvespy.com/api/work-orders?status=open&priority=low&category=plumbing&source=staff&sortBy=title&sortDirection=asc' \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

status

string

Allowed values: open in_progress completed cancelled

priority

string

Allowed values: low normal high emergency

category

string

Allowed values: plumbing electrical hvac appliance structural pest_control landscaping general other

propertyId

string format: uuid

unitId

string format: uuid

vendorId

string format: uuid

assignedStaffUserId

string format: uuid

source

string

Allowed values: staff tenant

createdAfter

string format: date

createdBefore

string format: date

sortBy

string

Allowed values: title status priority source createdAt

sortDirection

string

Allowed values: asc desc

scheduled

boolean

Responses

200

Default Response

Media typeapplication/json

object

noteSummaries

required

Array<object>

object

entityId

required

string format: uuid

latestNote

required

object

body

required

string

>= 1 characters <= 4000 characters

createdAt

required

string format: date-time

visibility

required

string

Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared

noteCount

required

integer

workOrders

required

Array<object>

object

assignedStaffUserId

required

string format: uuid

nullable

assignedVendorId

required

string format: uuid

nullable

category

required

string

nullable

Allowed values: plumbing electrical hvac appliance structural pest_control landscaping general other

completedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

deletedAt

required

string format: date-time

nullable

description

required

string

nullable

entryInstructions

required

string

nullable

id

required

string format: uuid

organizationId

required

string format: uuid

priority

required

string

Allowed values: low normal high emergency

propertyId

required

string format: uuid

relations

object

assignedStaffUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

assignedVendor

required

object

id

required

string format: uuid

name

required

string

>= 1 characters <= 160 characters

property

required

object

id

required

string format: uuid

name

required

string

>= 1 characters <= 160 characters

tenant

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

unit

required

object

id

required

string format: uuid

unitNumber

required

string

nullable >= 1 characters <= 32 characters

scheduledAt

required

string format: date-time

nullable

source

required

string

Allowed values: staff tenant

status

required

string

Allowed values: open in_progress completed cancelled

subcategory

required

string

nullable <= 100 characters

tenantId

required

string format: uuid

nullable

title

required

string

>= 1 characters <= 160 characters

unitId

required

string format: uuid

nullable

updatedAt

required

string format: date-time

Example

{
  "noteSummaries": [
    {
      "latestNote": {
        "visibility": "organization_only"
      }
    }
  ],
  "workOrders": [
    {
      "category": "plumbing",
      "priority": "low",
      "source": "staff",
      "status": "open"
    }
  ]
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}