---
title: "List Users"
method: GET
path: "/v4/organizations/{organizationId}/users"
tags: ["Users"]
---

# List Users

`GET /v4/organizations/{organizationId}/users`

Lists all the users in the organization and filter on the basis of projectId.

In order to access this endpoint, the provided API key must have at least one of the following roles:
- Organization Owner
- Organization Member
- Project Creator

The results are always limited by the role and scope of the caller's privileges.

When retrieving a list of users through a GET request, if a user holds the organization owner role, the response will exclude project-level permissions for those users. This is because organization owners have full access to all resources within the organization, making project-level permissions irrelevant for them.

To learn more about the roles, see [Organization Roles](https://docs.couchbase.com/cloud/organizations/organization-user-roles.html) and [Project Roles](https://docs.couchbase.com/cloud/projects/project-roles.html).

## Query parameters

- `page` integer
- `perPage` integer
- `sortBy` string[]
- `sortDirection` 'asc' | 'desc'
- `projectId` string, uuid

## Response `200`

Successfully listed all the user in the organization.

- GetUsersResponse
  - `data` GetUserResponse[], required
    - `id` string, required — The UUID of the user created.
    - `name` string, required — The name of the user.
    - `email` string, required — Email of the user.
    - `status` 'verified' | 'not-verified' | 'pending-primary', required — Depicts user status whether they are verified or not. - verified: It reflects a verified state for an email address where the user has proven that they have access to the email account. - not-verified: It reflects an unverified or pending verification state. - pending-primary: It reflects an unverified primary email address
    - `inactive` boolean, required — Depicts whether the user has accepted the invite for the organization.
    - `organizationId` string, required — A GUID4 identifier of the tenant.
    - `organizationRoles` OrganizationRoles[], required
    - `lastLogin` string, date-time — Time(UTC) at which user last logged in.
    - `region` string — Region of the user.
    - `timeZone` string — Time zone of the user.
    - `enableNotifications` boolean — After enabling email notifications for your account, you will start receiving email notification alerts from all databases in projects you are a part of.
    - `expiresAt` string, date-time — Time at which user expires.
    - `resources` Resource[]
      - `type` 'project' — Type of the resource.
      - `id` string, uuid, required — Id of the project.
      - `roles` ProjectRoles[], required
    - `audit` CouchbaseAuditData, required
      - `createdBy` string, required — The user who created the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users.
      - `createdAt` string, date-time, required — The RFC3339 timestamp associated with when the resource was initially created.
      - `modifiedBy` string, required — The user who last modified the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users.
      - `modifiedAt` string, date-time, required — The RFC3339 timestamp associated with when the resource was last modified.
      - `version` integer, required — The version of the document. This value is incremented each time the resource is modified.
  - `cursor` Cursor, required
    - `pages` Pages, required
      - `page` integer, required — Current page of results, starting from page 1.
      - `next` integer — Number of the next page of results. Not set on the last page.
      - `previous` integer — Number of the previous page of results. Not set on the first page.
      - `last` integer, required — Number of the last page of results.
      - `perPage` integer, required — Number of items displayed in each page.
      - `totalItems` integer, required — Total items found by the given query.
    - `hrefs` Hrefs, required
      - `first` string, uri, required — The base URL, endpoint, and path parameters required to fetch the first page of results.
      - `last` string, uri, required — The base URL, endpoint, and path parameters required to fetch the last page of results.
      - `previous` string, uri, required — The base URL, endpoint, and path parameters required to fetch the previous page of results. Empty if there is no previous page.
      - `next` string, uri, required — The base URL, endpoint, and path parameters required to fetch the next page of results. Empty if there is no next page.

## Other responses

- `400` — Returned when we are unable to decode the recevied payload.
- `403` — The client does not have the necessary permissions to access this resource.
- `404` — The requested resource was not found.
- `429` — Returned when the client exceeds the rate limit for the given APIKey.
- `500` — An unexpected error occurred in the server while processing this request.

---

[API](https://skmtc.net/couchbase/apis/couchbase-capella-management-api.md) · [All operations](https://skmtc.net/couchbase/apis/couchbase-capella-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/couchbase/couchbase-capella-management-api/revisions/27d3c1e98fee/schema)