Consulta de Usuário(s) Escritório.

GET

/v2/Usuarios/Escritorios

Este endpoint permite consultar usuários do tipo escritório. É possível buscar todos os usuários ativos ou filtrar a busca por um e-mail específico.
A consulta é realizada de forma eficiente e pode ser filtrada por parâmetros como e-mail. A resposta incluirá uma lista com todos os usuários encontrados ou uma mensagem de erro caso algo não corra bem.

Exemplo de Requisição (Rota):

Exemplo de Resposta de Sucesso (200 - OK):

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

Exemplo de Resposta de Erro (400 - Bad Request):

{
  "sucesso": false,
  "mensagens": "Parâmetros inválidos ou erro ao processar a consulta.",
  "dados": null
}

Requisição

Authorization

API Key

Adicionar parâmetro em header

Authorization

Exemplo:

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

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Sucesso. Retorna a lista de usuários encontrados.

Body

🟠400Solicitação incorreta

🟠404Não encontrado

🔴500Erro interno do servidor

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Exemplo 1

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

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

Página anterior

Criação de Usuário Escritório.

Próxima página

Consultar Pastas.