Consulta de Usuário(s) Empresa.

GET

/v2/Usuarios/Empresas

Este endpoint permite consultar os usuários associados a uma empresa específica, utilizando como filtros o Id da empresa ou o e-mail do usuário.
Ele retorna os usuários que atendem aos filtros fornecidos.

Validações:

O parâmetro EmpresaId pode ser opcional, mas se fornecido, ele deve ser válido.

O parâmetro email é opcional, mas caso seja fornecido, deve corresponder ao formato de e-mail válido.

Respostas:

Sucesso: Retorna uma lista de usuários encontrados que atendem aos filtros.

Falha: Detalha os erros, como parâmetros inválidos ou nenhum usuário encontrado.

Exemplo de Resposta de Sucesso:

{
  "sucesso": true,
 "mensagens": "",
  "dados": [
    { "id": "1", "nome": "John Doe", "email": "johndoe@example.com", "empresaId": "123" },
    { "id": "2", "nome": "Jane Smith", "email": "janesmith@example.com", "empresaId": "123" }
  ]
}

Exemplo de Resposta de Erro:

{
"sucesso": false,
 "mensagens":"Nenhum usuário encontrado.",
"dados": null
}

Requisição

Authorization

API Key

Adicionar parâmetro em header

Authorization

Exemplo:

Authorization: ********************

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Lista de usuários encontrados com sucesso.

Body

🟠400Solicitação incorreta

🟠404Não encontrado

🔴500Erro interno do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v2/Usuarios/Empresas?EmpresaId&email' \
--header 'Authorization: <api-key>'

Response Example

200 - Exemplo 1

{
    "sucesso": true,
    "mensagens": "string",
    "dados": {
        "id": "string",
        "nome": "string",
        "email": "string",
        "cpf": "string",
        "empresas": [
            {
                "idEmpresa": 0,
                "inscricaoFederal": "string"
            }
        ]
    }
}

Modificado em 2025-09-24 14:39:45

Página anterior

Criação de Usuário Empresa.

Próxima página

Vincular Usuário a Empresa(s).