> ## Documentation Index
> Fetch the complete documentation index at: https://velt.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Email Config

Use this API to retrieve the current email service configuration for a workspace.

> [!NOTE]
>
> This endpoint uses **API-key-level auth**: pass `x-velt-api-key` and `x-velt-auth-token` as headers. You can obtain these from the [Get Auth Tokens](https://velt.dev/docs/api-reference/rest-apis/v2/workspace/authtokens-get.md) endpoint.

# Endpoint

`POST https://api.velt.dev/v2/workspace/emailconfig/get`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

This endpoint does not require a request body.

# Example Request

```JSON theme={null}
{
  "data": {}
}
```

# Example Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Email configuration retrieved successfully.",
    "data": {
      "useEmailService": false,
      "emailServiceConfig": {
        "type": "default",
        "apiKey": "",
        "fromEmail": "",
        "fromCompany": "",
        "commentTemplateId": "",
        "tagTemplateId": ""
      }
    }
  }
}
```

#### Failure Response

```JSON theme={null}
{
  "error": {
    "status": "PERMISSION_DENIED",
    "message": "Invalid API key."
  }
}
```

```js theme={null}
{
  "result": {
    "status": "success",
    "message": "Email configuration retrieved successfully.",
    "data": {
      "useEmailService": false,
      "emailServiceConfig": {
        "type": "default",
        "apiKey": "",
        "fromEmail": "",
        "fromCompany": "",
        "commentTemplateId": "",
        "tagTemplateId": ""
      }
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.