---
title: "Get a user"
method: GET
path: "/v2/users/{username}"
tags: ["Users"]
---

# Get a user

`GET /v2/users/{username}`

Returns a user with details such as the email, username, and associated roles.

## Path parameters

- `username` string, required

## Headers

- `Request-Timeout` integer
- `Request-Timeout-Millis` integer

## Response `200`

A user.

- User — A user account with associated profile information and permissions.
  - `id` string, required — The Vectara ID for the user.
  - `email` string, email, required — The email address for the user.
  - `username` string — The username for the user.
  - `enabled` boolean — Indicates whether the user is enabled or disabled.
  - `description` string — The description of the user.
  - `created_at` string, date-time — When the user was created.
  - `updated_at` string, date-time — When a user property was last updated.
  - `api_roles` ApiRole[] — The customer-level role names of the user.
  - `corpus_roles` CorpusRole[] — Corpus-specific role assignments for the user.
    - `corpus_key` string, required — The key of the corpus this role applies to.
    - `role` 'owner' | 'administrator' | 'viewer' | 'editor', required — The role assigned for this specific corpus.
  - `agent_roles` AgentRole[] — Agent-specific role assignments for the user.
    - `agent_key` string, required — The key of the agent this role applies to. For the `agent_end_user` role this is an agent alias key, which shares the same shape.
    - `role` 'agent_administrator' | 'agent_viewer' | 'agent_developer' | 'agent_user' | 'agent_end_user', required — The role assigned for this specific agent. * `agent_administrator` - Full administrative access to the agent including deletion and configuration. * `agent_viewer` - Read-only access to view agent configuration, sessions, events, instructions, and tools. * `agent_developer` - Can modify agent configuration, create/manage sessions, update tools and instructions. * `agent_user` - Limited access to interact with the agent by creating sessions and sending inputs. Cannot view agent configuration or modify settings. * `agent_end_user` - Granted on an alias, lets a user create sessions and send messages through it. They see only their own sessions, and within them only their own messages and the agent's replies.
  - `api_policy` ApiPolicy — The actions a principal can take on the Vectara platform.
    - `name` string, required — The name of the API role.
    - `allowed_operations` object, required — The operations the API role allows. Each operation may allow only certain resources, described by a map of resource path to resource values. If the value is null, the operation allows any resource.
  - `metadata` object — Arbitrary metadata associated with the user.

## Other responses

- `403` — Permissions do not allow retrieving the user.
- `404` — User not found.

## Changes

- **2026-09-14** `c94fd099d78b` — 1 warning, 1 info
  - added the new `metrics_viewer` enum value to the `api_roles/items/` response property for the response status `200`
  - added the optional property `metadata` to the response with the `200` status
- **2026-08-05** `fca567a46b3a` — 1 warning
  - added the new `agent_end_user` enum value to the `agent_roles/items/role` response property for the response status `200`

[Change history](https://skmtc.dev/vectara/apis/vectara-rest-api-v2/changes/v2/users/:username/get.md)

---

[API](https://skmtc.dev/vectara/apis/vectara-rest-api-v2.md) · [All operations](https://skmtc.dev/vectara/apis/vectara-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc.dev/vectara/apis/vectara-rest-api-v2/revisions/4557c44ba062?raw)