VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Usuários (REST)

Paginação

Parâmetros de consulta do GET /api/users que definem quantos usuários voltam e qual página é exibida.

Uma loja pode ter milhares de contas, por isso GET /api/users devolve os usuários uma página por vez. Dois parâmetros de consulta controlam a página: qual exibir e quantos usuários ela comporta. Usá-los mantém as respostas pequenas e rápidas.

GET/api/usersAdmin

Retorna usuários com paginação

Parâmetros de consulta

pageintegerpadrão: 1
Define qual página de usuários exibir. As páginas são numeradas a partir de 1.
items_per_pageintegerpadrão: 10
Controla quantos usuários entram em cada página.
Dica

Usar paginação é essencial com grandes volumes de usuários: melhora o desempenho e reduz o tempo de resposta.

Exemplos

Só a página

Esta requisição retorna 10 usuários da 5ª página. Como items_per_page não foi informado, vale o padrão de 10.

bash
curl "$BASE_URL/api/users?page=5" \
  -u "$EMAIL:$API_KEY"

Só o tamanho da página

Esta requisição retorna 20 usuários da primeira página. Como page não foi informado, vale o padrão 1.

bash
curl "$BASE_URL/api/users?items_per_page=20" \
  -u "$EMAIL:$API_KEY"

Os dois parâmetros

Esta requisição retorna 20 usuários da 5ª página. Com os dois parâmetros informados, você tem controle total sobre o resultado.

bash
curl "$BASE_URL/api/users?page=5&items_per_page=20" \
  -u "$EMAIL:$API_KEY"

Formato da resposta

A API devolve um array JSON de objetos de usuário conforme os parâmetros de paginação. A resposta também inclui metadados de paginação: a página atual, os itens por página e o total de usuários disponíveis.

Campos omitidos

Por segurança, informações sensíveis do usuário podem ser omitidas das respostas, conforme o seu nível de autenticação e as suas permissões na API.

Veja também

  • Endpoints de usuários
  • Campos de usuário
Anterior
Endpoints de usuários
Próxima
Campos de usuário
Nesta página
  • Exemplos
  • Só a página
  • Só o tamanho da página
  • Os dois parâmetros
  • Formato da resposta
  • Veja também