---
title: "Retrieve email provider configuration"
method: GET
path: "/projects/{project_id}/branches/{branch_id}/auth/email_provider"
tags: ["Auth"]
---

# Retrieve email provider configuration

`GET /projects/{project_id}/branches/{branch_id}/auth/email_provider`

Retrieves the email provider configuration for the specified branch's Neon Auth integration,
including the provider type and server settings.

## Response `200`

Returns the email provider configuration for the Neon Auth

- union
  - object
    - `host` string, required
    - `port` integer, required
    - `username` string, required
    - `password` string, required
    - `sender_email` string, required
    - `sender_name` string, required
  - object
    - `sender_email` string
    - `sender_name` string

## Other responses

- `default` — General Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.

---

[API](https://skmtc.net/neon/apis/neon-api.md) · [All operations](https://skmtc.net/neon/apis/neon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/neon/neon-api/versions/cfde79a5c713/schema)