Listar Todos os Usuários (API)

🚧 Importante: Para usar este método, seu domínio precisa estar validado. Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.

Exemplo de URL completa para requisição: https://secure.d4sign.com.br/api/v1/users/list?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}&pg=1

Header

O cabeçalho da sua requisição deve conter o Content-Type como application/json.

JSON

{
    "Content-Type": "application/json"
}

Body

Para este endpoint, o corpo da requisição não é necessário. A paginação é controlada por um parâmetro na URL.

Parâmetros de Requisição (URL)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`pg`	Número	Opcional	O número da página que você deseja listar. Cada página retorna até 500 usuários.

Resposta (Status 200 - Sucesso)

Quando a requisição for bem-sucedida, você receberá um array de objetos JSON, onde o primeiro bloco exibirá o total de páginas disponíveis e os subsequentes apresentarão os detalhes de cada usuário.

JSON

[
    {
        "total_documents": 1500,
        "total_in_this_page": 500,
        "current_page": 1,
        "total_pages": 3
    },
    {
        "nome": "Nome do usuário",
        "email": "email@usuario.com.br",
        "status": "1",
        "apenas_cofre_compartilhado": "0"
    }
    // ... outros usuários
]

Detalhes dos Campos da Resposta:

Campo	Tipo	Descrição
`total_documents`	Número	O número total de usuários encontrados (se presente no primeiro objeto do array).
`total_in_this_page`	Número	O número de usuários retornados na página atual (se presente no primeiro objeto do array).
`current_page`	Número	O número da página atual que está sendo exibida (se presente no primeiro objeto do array).
`total_pages`	Número	O número total de páginas disponíveis para listagem (se presente no primeiro objeto do array).
`nome`	String	O nome do usuário.
`email`	String	O e-mail do usuário.
`status`	String	O status do usuário (ex: `1` para ativo).
`apenas_cofre_compartilhado`	String	Indica se o usuário tem permissão para acessar apenas cofres compartilhados (`1`) ou não (`0`).

🚧 Observações Importantes:

Domínio Validado: Este endpoint requer que o seu domínio esteja validado na D4Sign para funcionar corretamente.
Paginação: O resultado é paginado, retornando até 500 usuários por página. Use o parâmetro pg na URL para navegar entre as páginas.
Primeiro Bloco da Resposta: O primeiro objeto no array da resposta sempre trará informações sobre a paginação, incluindo o total_pages.

Listar Todos os Usuários (API)

Este endpoint da API D4Sign permite que você liste todos os usuários associados ao seu domínio. É uma ferramenta essencial para gerenciar sua base de usuários na plataforma.

Detalhes dos Campos da Resposta:

🚧 Observações Importantes: