> API Reference / Authentication / Retrieve email provider configuration

## GET /projects//branches//auth/email\_provider

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

### Parameters

- `project_id` (string, path, required)
  The Neon project ID
- `branch_id` (string, path, required)
  The Neon branch ID

### Response (200)

```json
{
  "type": "shared",
  "sender_email": "alex@example.com",
  "sender_name": "Neon Auth"
}
```

### Code examples

```bash
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/email_provider" \
  -H "Authorization: Bearer $NEON_API_KEY"
```

```typescript
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.getNeonAuthEmailProvider({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID
  }
});
```

```bash
# neonctl
neon neon-auth config email-provider get
```

### MCP

Tool: `get_neon_auth_config`

Read full Neon Auth configuration for a branch. Do not use when you need to update config (use `configure_neon_auth` instead). Requires Neon Auth to be provisioned first (use `provision_neon_auth`). Returns Neon Auth (Better Auth) for a branch as one JSON object: integration metadata (base\_url, jwks\_url, db\_name, auth\_provider, branch\_id, created\_at, owned\_by, transfer\_status, auth\_provider\_project\_id), branch\_name from the Neon branch API, project\_id and resolved branch\_id, plus the same configurable fields as configure\_neon\_auth (trusted\_origins, allow\_localhost, auth\_methods.email\_password with enabled, allow\_sign\_up, verify\_email\_on\_sign\_up, verify\_email\_on\_sign\_in, email\_verification\_method, require\_email\_verification, auto\_sign\_in\_after\_verification, oauth\_providers (id, type, client\_id, client\_secret), email\_provider (discriminated by type)). Top-level base\_url, jwks\_url, and db\_name duplicate integration for quick copy. Optional \_errors records partial fetch failures for configurable slices. Secrets — OAuth client\_secret and the SMTP password — are NEVER returned. When the upstream config indicates a secret is set, this endpoint surfaces it as the literal sentinel "_**redacted**_"; when no secret is set the field is null. Use the matching configure\_neon\_auth operations to write or rotate these values.

- `projectId` (string, required)
  Neon project ID
- `branchId` (string, optional)
  Branch ID. If omitted, the project default branch is used (same as provision\_neon\_auth).

### Console

Console path: Projects → Auth → Configuration

### Errors

**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.

- `request_id` (string, optional)
  Unique identifier for the request, useful for debugging.
  You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

- `code` (string, required)
  Machine-readable code classifying the error type. See `message` for a human-readable explanation.
  Default: \`\`

- `message` (string, required)
  Error message

## Related pages

- [Add an OAuth provider](./apis-sdks-reference-api-auth-add-branch-neon-auth-oauth-provider.md)
- [Add domain to redirect_uri whitelist](./apis-sdks-reference-api-auth-add-branch-neon-auth-trusted-domain.md)
- [Create new auth user](./apis-sdks-reference-api-auth-create-branch-neon-auth-new-user.md)
- [Delete auth user](./apis-sdks-reference-api-auth-delete-branch-neon-auth-user.md)
- [Delete domain from redirect_uri whitelist](./apis-sdks-reference-api-auth-delete-branch-neon-auth-trusted-domain.md)
- [Delete OAuth provider](./apis-sdks-reference-api-auth-delete-branch-neon-auth-oauth-provider.md)
- [Disable Neon Auth for the branch](./apis-sdks-reference-api-auth-disable-neon-auth.md)
- [Enable Neon Auth for the branch](./apis-sdks-reference-api-auth-create-neon-auth.md)
- [List domains in redirect_uri whitelist](./apis-sdks-reference-api-auth-list-branch-neon-auth-trusted-domains.md)
- [List OAuth providers for the branch](./apis-sdks-reference-api-auth-list-branch-neon-auth-oauth-providers.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.