# Retrieve database schema

`GET /projects/{project_id}/branches/{branch_id}/schema`

Retrieves the database schema. Specify `lsn` or `timestamp` (not both) to read at a point in time; omit both to read from the database's head.

[Markdown for AI context](/guides/apis-sdks-reference-api-branches-get-project-branch-schema)

```bash title="REST API - curl"
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/schema?db_name=$DB_NAME" \
  -H "Authorization: Bearer $NEON_API_KEY"
```

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

Also available in

::::tabs
:::tab{title="CLI"}
```bash
neon branches schema-diff [base] [compare]
```
:::

:::tab{title="SDK"}
:::

:::tab{title="Console"}
Console path: Projects → Branches
:::
::::

## Parameters

Project ID

`project_id`

string

The Neon project ID

Branch ID

`branch_id`

string

The branch ID

Db name

`db_name`

string

Name of the database for which the schema is retrieved

LSN

`lsn`

string

The Log Sequence Number (LSN) for which the schema is retrieved

Timestamp

`timestamp`

string

The point in time for which the schema is retrieved

Format

`format`

string

The format of the schema to retrieve. Possible values:

- `sql` (default)
- `json`

## Response

200

Schema definition

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

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

"sql": (string),

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

- [Compare database schema](./apis-sdks-reference-api-branches-get-project-branch-schema-comparison.md)
- [Create anonymized branch](./apis-sdks-reference-api-branches-create-project-branch-anonymized.md)
- [Create branch](./apis-sdks-reference-api-branches-create-project-branch.md)
- [Create database](./apis-sdks-reference-api-branches-create-project-branch-database.md)
- [Create role](./apis-sdks-reference-api-branches-create-project-branch-role.md)
- [Delete branch](./apis-sdks-reference-api-branches-delete-project-branch.md)
- [Delete database](./apis-sdks-reference-api-branches-delete-project-branch-database.md)
- [Delete role](./apis-sdks-reference-api-branches-delete-project-branch-role.md)
- [Finalize branch restore from snapshot](./apis-sdks-reference-api-branches-finalize-restore-branch.md)
- [List branch endpoints](./apis-sdks-reference-api-branches-list-project-branch-endpoints.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.