Skip to content
Vespy API

List users in current organization

GET
/api/accounts/users
curl --request GET \
  --url 'https://api.getvespy.com/api/accounts/users?role=admin' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string
>= 1 characters <= 100 characters
role
string
Allowed values: admin manager staff tenant owner
includeInactive
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
users
required
Array<object>
object
deletedAt
required
string format: date-time
nullable
email
required
string format: email
emailConsentAt
required
string format: date-time
nullable
fullName
required
string
id
required
string format: uuid
isActive
required
boolean
isSuperadmin
required
boolean
organizationId
required
string format: uuid
phone
required
string
nullable
role
required
string
Allowed values: admin manager staff tenant owner vendor
smsConsentAt
required
string format: date-time
nullable
Example
{
  "users": [
    {
      "role": "admin"
    }
  ]
}

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