Get an organization email account

GET

/api/settings/email-accounts/{id}

curl --request GET \
  --url https://api.getvespy.com/api/settings/email-accounts/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

account

required

object

createdAt

required

string format: date-time

displayName

required

string

nullable

emailAddress

required

string format: email

enabled

required

boolean

id

required

string format: uuid

isDefault

required

boolean

organizationId

required

string format: uuid

provider

required

string

Allowed values: system gmail outlook imap

updatedAt

required

string format: date-time

verified

required

boolean

Example

{
  "account": {
    "provider": "system"
  }
}

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