# Retrieve phone number plugin configuration

`GET /projects/{project_id}/branches/{branch_id}/auth/plugins/phone-number`

Returns the phone number plugin configuration for Neon Auth. The phone number plugin enables phone-based OTP authentication.

[Markdown for AI context](/guides/apis-sdks-reference-api-auth-get-neon-auth-phone-number-plugin)

```bash title="REST API - curl"
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/plugins/phone-number" \
  -H "Authorization: Bearer $NEON_API_KEY"
```

Every field below is optional. An empty body works too.

```typescript title="Also available in"
import { createNeonClient, raw } from '@neon/sdk';

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

## Parameters

Project ID

`project_id`

string

The Neon project ID

Branch ID

`branch_id`

string

The Neon branch ID

## Response

200

Returns the phone number plugin configuration

::::tabs
:::tab{title="schema"}
Depth
:::

:::tab{title="example"}
:::
::::

"enabled": false,req

"otp\_expires\_in": 300,min: 60, max: 600

## Errors

default

General error

This endpoint can return the standard Neon API error response.

Response fields

- `message` Required. Human-readable error message.
- `code` Required. Machine-readable error code.
- `request_id` Optional. Request identifier for debugging. You can provide one with the `X-Request-ID` header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (`GET`, `HEAD`, `OPTIONS`) are generally safe to retry after a network error or timeout. Non-idempotent methods (`POST`, `PATCH`, `DELETE`, `PUT`) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with `423 Locked` or `503 Service Unavailable` are safe to retry. `423 Locked` means the resource is temporarily locked, usually because another operation is in progress.

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