> For the complete documentation index, see [llms.txt](https://docs.vaultid.com.br/workspace/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vaultid.com.br/workspace/wings/corporativo/consultar-usuarios.md).

# Consultar Usuários

<table data-header-hidden><thead><tr><th width="190"></th><th></th></tr></thead><tbody><tr><td><strong>URL</strong></td><td><code>/corporation-user</code></td></tr><tr><td><strong>Methods</strong></td><td><code>GET</code></td></tr><tr><td><strong>Headers</strong></td><td></td></tr><tr><td><code>Authorization</code></td><td><code>Bearer ***</code> onde <code>***</code> é o token obtido na <a href="/pages/Uqo6oRfrxcnZRlyKREYB#autenticacao-de-usuario">autenticação de usuário</a></td></tr><tr><td><strong>Search Params</strong></td><td></td></tr><tr><td><code>page</code></td><td><code>Number</code> | Opcional | Número da página na paginação.</td></tr><tr><td><code>search</code></td><td><code>String</code> | Opcional | Valor a ser consultado nos campos nome e CPF do usuário.</td></tr><tr><td><code>status</code></td><td><p><code>Number</code> | Opcional | Filtra os usuários pelo seu status seguindo a seguinte lógica:</p><p>- habilitados = 0<br>- bloqueados = 2<br>- removidos = 4<br>- bloqueados e removidaos = 6</p></td></tr><tr><td><code>hideEnabled</code></td><td><code>Bit</code> | Opcional | Quando informado, a consulta não trás os usuários habilitados.</td></tr><tr><td><code>userClass</code></td><td><code>String</code> | Opcional | Classe dos usuários a serem consultados. Pode receber os valores <code>user_corporation</code>, <code>user_signer</code> </td></tr><tr><td><strong>Success Response</strong></td><td><p><strong>Code:</strong> <code>200</code></p><pre class="language-json"><code class="lang-json">{
    "_embedded": {
        "corporation_user": [
            {
                "id": 285,
                "status": 0,
                "username": "18168930800",
                "name": "CERTIFICADO TESTE VAULTID",
                "email": null,
                "phoneNumber": null,
                "userUnique": "e2c8080fbf079a79daafb484f3f3a46e",
                "userType": null,
                "userClass": "user_corporation",
                "serialNumber": null,
                "initDate": {
                    "date": "2021-04-08 00:00:00.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "updatedDateTime": {
                    "date": "2024-04-08 01:58:07.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "activationDate": {
                    "date": "2022-03-30 00:00:00.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "expireAt": {
                    "date": "2025-04-07 23:59:59.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "expireAtCertificate": null,
                "expireTime": null,
                "autoRenovation": null,
                "inheritedExpireTime": "+1 year",
                "inheritedAutoRenovation": 1,
                "_links": {
                    "self": {
                        "href": "https://billing.hom.vaultid.com.br/corporation-user/285"
                    }
                }
            },
            ...
        ]
    },
    "page_count": 2,
    "page_size": 25,
    "total_items": 41,
    "page": 1
}
</code></pre></td></tr><tr><td><strong>Error Response</strong></td><td><p><strong>Code:</strong> <code>401</code><br><strong>Content:</strong> </p><pre class="language-json"><code class="lang-json">{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Unauthorized",
    "status": 401,
    "detail": "User auth error."
}
</code></pre></td></tr></tbody></table>

#### **Exemplo**

```sh
curl --location 'https://billing.hom.vaultid.com.br/corporation-user?page=1&status=0' \
--header 'Authorization: Bearer 5febf3bc80a6615ad2fecbcae61670bf9e123a98'
```

### Ambientes

* Homologação: [https://billing.hom.vaultid.com.br](https://billing.hom.vaultid.com.br/auth)
* Produção: [https://billing.vaultid.com.br](https://billing.vaultid.com.br/auth)
