---
title: "Listagem de usuários por organização"
method: GET
path: "/auth/api/v1/users"
---

# Listagem de usuários por organização

`GET /auth/api/v1/users`

## Request

- Base URL: `https://apigw.nuvidio.com`
- URL: `https://apigw.nuvidio.com/auth/api/v1/users`
- Auth: OAuth 2

Consulte os usuários ativos da organização autenticada, com busca e paginação.

## Query parameters

- `search` string
- `page` integer
- `take` integer

## Response `200`

200

- object
  - `data` object[], required: Usuários ativos da organização na página pedida, já filtrados pelo search.
    - `id` string, uuid, required: Identificador do usuário.
    - `name` string, required: Nome do usuário. Vem como string vazia quando não informado.
    - `email` string, nullable, required: E-mail do usuário. É null quando o usuário não tem e-mail, como os usuários de API key.
    - `applications` object, required: Perfil do usuário em cada aplicação. Sempre traz as chaves agreement_dashboard e agreement_manager.
      - `agreement_dashboard` object
        - `roles` object[]: Perfil do usuário em agreement_dashboard (owner, writer ou reader). No máximo um item; vazio quando o usuário não tem acesso à aplicação.
          - `id` string, uuid: Identificador do perfil.
          - `name` string: Nome do perfil.
      - `agreement_manager` object
        - `roles` object[]: Perfil do usuário em agreement_manager (owner ou writer). No máximo um item; vazio quando o usuário não tem acesso à aplicação.
          - `id` string, uuid: Identificador do perfil.
          - `name` string: Nome do perfil.
  - `meta` object, required
    - `total` integer, required: Total de usuários ativos da organização que atendem ao search. É a base da paginação. Sem search, é igual a users.
    - `users` integer, required: Total de usuários ativos da organização, sem aplicar o search.
    - `owners` integer, required: Total de usuários ativos da organização com o perfil owner em pelo menos uma aplicação, sem aplicar o search. Cada usuário conta uma vez.
    - `page` integer, required: Página devolvida.
    - `take` integer, required: Tamanho de página aplicado.

## Other responses

- `400`: 400
- `401`: 401
- `403`: 403
- `500`: 500

---

[API](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2.md) - [All operations](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2/revisions/c488e657f07b?raw)