Skip to content
Vespy API

Validate vendor invite token

GET
/api/vendor-invites/{token}
curl --request GET \
  --url https://api.getvespy.com/api/vendor-invites/example

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
token
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
invite
required
object
acceptedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
createdByUserId
required
string format: uuid
nullable
email
required
string format: email
expiresAt
required
string format: date-time
id
required
string format: uuid
organizationId
required
string format: uuid
revokedAt
required
string format: date-time
nullable
status
required
string
Allowed values: pending accepted expired
token
required
string
>= 1 characters
vendorId
required
string format: uuid
vendor
required
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
{
  "invite": {
    "status": "pending"
  }
}

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

404

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