> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toolzz.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter Membro por Unidade

> Endpoint para obter todos os Membros

## Token de Acesso

<ParamField header="Authorization" type="string">
  Token de acesso ("Bearer" deve estar antes do token)
</ParamField>

## Corpo da Requisição

<ParamField path="id" type="string" required="true" placeholder="Enter with UnityId">
  O ID da Unidade
</ParamField>

## Descrição da Resposta

O endpoint retorna uma resposta em formato JSON com a confirmação da solicitação.

<ResponseField name="message" type="string" required>
  Mensagem indicando o resultado da operação.
</ResponseField>

<ResponseField name="items" type="array" required>
  Lista de membros recuperados.

  <Expandable title="Items">
    <ResponseField name="message" type="string" required>
      Mensagem para a operação individual.
    </ResponseField>

    <ResponseField name="id" type="string" required>
      Identificador único do membro.
    </ResponseField>

    <ResponseField name="institutionId" type="string" required>
      ID da instituição associada.
    </ResponseField>

    <ResponseField name="unityId" type="string" required>
      ID da unidade associada.
    </ResponseField>

    <ResponseField name="userId" type="string" required>
      ID do usuário associado.
    </ResponseField>

    <ResponseField name="name" type="string" required>
      Nome do membro.
    </ResponseField>

    <ResponseField name="email" type="string" required>
      E-mail do membro.
    </ResponseField>

    <ResponseField name="access" type="string" required>
      Nível de acesso do membro.

      <Expandable title="Valores permitidos">
        <ResponseField name="MANAGER" type="string">
          Nível de acesso para operações de gerenciamento.
        </ResponseField>

        <ResponseField name="ADMIN" type="string">
          Nível de acesso para controle administrativo.
        </ResponseField>

        <ResponseField name="USER" type="string">
          Nível de acesso para usuários gerais.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="number" required>
      Indicador de status, 1 para ativo, 0 para inativo.
    </ResponseField>

    <ResponseField name="acceptedAt" type="string" required>
      Data/hora em que o membro foi aceito.
    </ResponseField>

    <ResponseField name="createdAt" type="string" required>
      Data/hora em que o registro foi criado.
    </ResponseField>

    <ResponseField name="updatedAt" type="string" required>
      Data/hora em que o registro foi atualizado pela última vez.
    </ResponseField>

    <ResponseField name="user" type="object">
      Detalhes do usuário associado.

      <Expandable title="Propriedades do usuário">
        <ResponseField name="id" type="string" required>
          Identificador único do usuário.
        </ResponseField>

        <ResponseField name="name" type="string" required>
          Primeiro nome do usuário.
        </ResponseField>

        <ResponseField name="lastName" type="string" required>
          Sobrenome do usuário.
        </ResponseField>

        <ResponseField name="email" type="string" required>
          E-mail do usuário.
        </ResponseField>

        <ResponseField name="phone" type="string">
          Número de telefone opcional do usuário.
        </ResponseField>

        <ResponseField name="password" type="string" required>
          Senha criptografada do usuário.
        </ResponseField>

        <ResponseField name="imgProfileId" type="string">
          ID da imagem de perfil opcional.
        </ResponseField>

        <ResponseField name="rememberMeToken" type="string">
          Token de lembrar-me opcional do usuário.
        </ResponseField>

        <ResponseField name="verified" type="boolean" required>
          Indica se o e-mail do usuário está verificado.
        </ResponseField>

        <ResponseField name="isMember" type="boolean" required>
          Indica se o usuário é membro.
        </ResponseField>

        <ResponseField name="institutionId" type="string" required>
          ID da instituição associada ao usuário.
        </ResponseField>

        <ResponseField name="imgProfile" type="string">
          URL opcional da imagem de perfil do usuário.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="avatar" type="string">
      URL opcional do avatar do membro.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="skip" type="number" required>
  Número de itens ignorados na consulta.
</ResponseField>

<ResponseField name="take" type="number" required>
  Número de itens retornados na consulta.
</ResponseField>

<ResponseField name="orderBy" type="string" required>
  Campo e ordem pela qual os itens são ordenados.
</ResponseField>

<ResponseField name="totalCount" type="number" required>
  Número total de itens disponíveis.
</ResponseField>

## Segurança

Para acessar este endpoint, é necessário enviar um **token de acesso** válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.

### Erros

Exemplos de erro de segurança

<Expandable title="erro 🚦">
  <ResponseField name="200" type="string">
    Resposta de sucesso da requisição
  </ResponseField>

  <ResponseField name="500" type="string">
    Falha na requisição
  </ResponseField>
</Expandable>