---
title: "Retrieve role details"
method: GET
path: "/projects/{project_id}/branches/{branch_id}/roles/{role_name}"
tags: ["Branch"]
---

# Retrieve role details

`GET /projects/{project_id}/branches/{branch_id}/roles/{role_name}`

## Request

- Base URL: `https://console.neon.tech/api/v2`
- URL: `https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/roles/{role_name}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `zenith`
  - API key in cookie `keycloak_token`

Retrieves details about the specified role.
In Neon, the terms "role" and "user" are synonymous.
For related information, see [Manage roles](https://neon.com/docs/manage/roles/).

## Response `200`

Returned details for the specified role

- RoleResponse
  - `role` Role, required
    - `branch_id` string, required: The ID of the branch to which the role belongs
    - `name` string, required: The role name
    - `password` string: The role password
    - `protected` boolean: Whether or not the role is system-protected
    - `authentication_method` string: Authentication method configured for this role. Valid options: `password`, `oauth`, `no_login`
    - `created_at` string, date-time, required: A timestamp indicating when the role was created
    - `updated_at` string, date-time, required: A timestamp indicating when the role was last updated

## 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.dev/neon/apis/neon-api.md) · [All operations](https://skmtc.dev/neon/apis/neon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/neon/apis/neon-api/revisions/cfde79a5c713?raw)