Get a work order with notes, expenses, and attachments

GET

/api/work-orders/{id}

curl --request GET \
  --url https://api.getvespy.com/api/work-orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

attachmentCount

required

integer

attachments

required

Array<object>

object

aiAnalysis

required

object

analyzedAt

required

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

null

null

error

required

Any of:

object

object

code

required

string

>= 1 characters <= 80 characters

message

required

string

>= 1 characters <= 500 characters

null

null

model

required

Any of:

string

string

>= 1 characters <= 255 characters

null

null

result

required

Any of:

object

Any of:

object

One of:

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

endDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

landlordNames

required

Array<string>

propertyAddress

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

rentAmountCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

securityDepositCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

startDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

tenantNames

required

Array<string>

documentType

required

string

Allowed values: lease

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

coverageTypes

required

Array<string>

effectiveDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

expirationDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

insuredName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

insurerName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

policyNumber

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: certificate_of_insurance

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

address

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

businessName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

legalName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

taxClassification

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: w9

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

currency

required

Any of:

string

string

>= 3 characters <= 3 characters

null

null

dueDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

invoiceNumber

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

issueDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

lineItems

required

Array<object>

object

amountCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

description

required

string

>= 1 characters <= 500 characters

quantity

required

Any of:

number

number

null

null

totalAmountCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

vendorName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: invoice_receipt

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

effectiveDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

expirationDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

keyTerms

required

Array<string>

title

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: contract

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

findings

required

Array<string>

inspectionDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

inspectorName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

propertyAddress

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: inspection

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

effectiveDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

noticeDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

noticeType

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

recipient

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

requiredAction

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: notice

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

currency

required

Any of:

string

string

>= 3 characters <= 3 characters

null

null

periodEnd

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

periodStart

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

statementType

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

totalAmountCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

documentType

required

string

Allowed values: financial_statement

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

effectiveDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

expirationDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

issuingAuthority

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

licenseNumber

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

licenseType

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: vendor_license

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

keyFacts

required

Array<string>

documentType

required

string

Allowed values: other

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

Any of:

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: property_image

visualCategory

required

string

Allowed values: property_exterior property_interior unit damage maintenance amenity general_photo other

visualSummary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: general_image

visualCategory

required

string

Allowed values: property_exterior property_interior unit damage maintenance amenity general_photo other

visualSummary

required

string

>= 1 characters <= 4000 characters

null

null

status

required

string

Allowed values: not_requested queued processing completed failed unsupported

category

required

string

nullable

createdAt

required

string format: date-time

description

required

string

nullable

entityId

required

string format: uuid

nullable

entityType

required

string

nullable

Allowed values: property unit tenant owner payment expense lease vendor work_order charge expense_payment

expiresAt

required

string format: date-time

nullable

id

required

string format: uuid

mimeType

required

string

>= 1 characters <= 255 characters

name

required

string

>= 1 characters <= 255 characters

organizationId

required

string format: uuid

sizeBytes

required

integer

storagePath

required

string

>= 1 characters

tags

required

Array<string>

nullable

updatedAt

required

string format: date-time

uploadedBy

required

string format: uuid

nullable

uploadedByName

required

string

nullable

linkedExpenses

required

Array<object>

object

amountCents

required

integer

>= 1

amountPaidCents

required

integer

category

required

string

Allowed values: maintenance utility tax insurance management other

categoryId

required

string format: uuid

nullable

createdAt

required

string format: date-time

description

required

string

nullable

id

required

string format: uuid

incurredOn

required

string format: date

lastPaidAt

required

string format: date-time

nullable

lease

required

object

endDate

required

string format: date

nullable

id

required

string format: uuid

startDate

required

string format: date

status

required

string

Allowed values: draft active terminated expired

leaseId

required

string format: uuid

nullable

name

required

string

nullable <= 160 characters

organizationId

required

string format: uuid

outstandingCents

required

integer

owner

required

object

fullName

required

string

id

required

string format: uuid

ownerId

required

string format: uuid

nullable

paymentStatus

required

string

Allowed values: pending partial paid

property

required

object

city

required

string

>= 1 characters <= 120 characters

id

required

string format: uuid

name

required

string

state

required

string

>= 2 characters <= 2 characters

propertyId

required

string format: uuid

nullable

status

required

string

Allowed values: active voided

unit

required

object

id

required

string format: uuid

unitNumber

required

string

nullable

unitId

required

string format: uuid

nullable

vendorId

required

string format: uuid

nullable

vendorName

required

string

nullable

workOrderId

required

string format: uuid

nullable

notes

required

Array<object>

object

body

required

string

>= 1 characters <= 4000 characters

createdAt

required

string format: date-time

createdByUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

createdByUserId

required

string format: uuid

nullable

entityId

required

string format: uuid

entityType

required

string

Allowed values: property unit owner tenant lease vendor work_order

id

required

string format: uuid

visibility

required

string

Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared

workOrder

required

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

{
  "attachments": [
    {
      "aiAnalysis": {
        "result": {
          "contentKind": "document",
          "documentType": "lease"
        },
        "status": "not_requested"
      },
      "entityType": "property"
    }
  ],
  "linkedExpenses": [
    {
      "category": "maintenance",
      "lease": {
        "status": "draft"
      },
      "paymentStatus": "pending",
      "status": "active"
    }
  ],
  "notes": [
    {
      "entityType": "property",
      "visibility": "organization_only"
    }
  ],
  "workOrder": {
    "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"
}

404

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"
}