Skip to content
Vespy API

List vendors with note and compliance summaries

GET
/api/vendors
curl --request GET \
  --url 'https://api.getvespy.com/api/vendors?complianceStatus=compliant&sortBy=name&sortDirection=asc' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
trade
string
>= 1 characters <= 120 characters
isActive
boolean
search
string
>= 1 characters <= 120 characters
createdAfter
string format: date
createdBefore
string format: date
complianceStatus
string
Allowed values: compliant warning missing expired
sortBy
string
Allowed values: name trade isActive createdAt
sortDirection
string
Allowed values: asc desc

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
complianceSummaries
required
Array<object>
object
expiredCount
required
integer
expiringSoonCount
required
integer
missingRequirements
required
Array<string>
Allowed values: coi w9
status
required
string
Allowed values: compliant warning missing expired
totalDocuments
required
integer
vendorId
required
string format: uuid
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
vendors
required
Array<object>
object
createdAt
required
string format: date-time
deletedAt
required
string format: date-time
nullable
email
required
string format: email
nullable
id
required
string format: uuid
isActive
required
boolean
name
required
string
>= 1 characters <= 160 characters
notes
required
string
nullable <= 2000 characters
organizationId
required
string format: uuid
phone
required
string
nullable >= 7 characters <= 32 characters
trade
required
string
nullable >= 1 characters <= 120 characters
updatedAt
required
string format: date-time
userId
required
string format: uuid
nullable
Example
{
  "complianceSummaries": [
    {
      "missingRequirements": [
        "coi"
      ],
      "status": "compliant"
    }
  ],
  "noteSummaries": [
    {
      "latestNote": {
        "visibility": "organization_only"
      }
    }
  ]
}

400

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}