# List branch log fields

`GET /projects/{project_id}/branches/{branch_id}/logs/fieldsbeta`

Lists the low-cardinality log fields observed on this branch whose distinct values can be discovered with the log field-values endpoint.

The set is computed per branch and grows as new fields are observed, so treat it as data rather than a fixed list: discover a field here, then pass it as `field_name` to the field-values endpoint.

**Note**: This endpoint is currently in Private Beta.

[Markdown for AI context](/guides/apis-sdks-reference-api-logs-list-project-branch-log-fields)

```bash title="REST API - curl"
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/logs/fields" \
  -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 logs fields
```
:::

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

:::tab{title="MCP"}
Tool: `list_log_fields`

List the log fields whose values list\_log\_field\_values can enumerate for a branch. The endpoint currently returns `service_name`, `severity_text`, `scope_name`, and `entity_type`. Call this tool instead of hardcoding that set so clients remain compatible if the endpoint adds fields. Fields without a structured query\_logs input can be filtered through raw logql.

- `projectId` (string, optional)
  The ID of the project. Defaults to your only project if unambiguous.
- `branchId` (string, optional)
  The ID of the branch. Defaults to the project's default branch.
:::
::::

## Parameters

Project ID

`project_id`

string

The Neon project ID

Branch ID

`branch_id`

string

The Neon branch ID

## Response

200

Log fields available for value discovery on this branch

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

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

"fields": (array),req

## Errors

404

Logs are not available for this branch, or the project/branch was not found. The body is always `ProjectBranchLogsNotAvailable` — see `reason` for the exact cause.

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

- [List branch log field values](./apis-sdks-reference-api-logs-list-project-branch-log-field-values.md)
- [Query branch logs](./apis-sdks-reference-api-logs-query-project-branch-logs.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.