Skip to content

Listar usuários

GET
/users

Para buscar usuários, utilize o método GET na rota /users. Este método requer os seguintes parâmetros:

  • filter: Filtro de busca

Este método retorna um array de objetos com os dados dos usuários encontrados, incluindo:

  • uuid: Identificador único do usuário
  • name: Nome do usuário
  • email: E-mail do usuário
  • phone: Telefone do usuário
  • role: Função do usuário
  • emailVerified: Usuário verificado por e-mail
  • createdAt: Data de criação do usuário
  • updatedAt: Data de atualização do usuário
  • lastLoginAt: Data do último login do usuário

Importante:

  • O token de acesso deve ser enviado no cabeçalho da requisição, no campo Authorization.

Parâmetros

Parâmetros de Consulta

filter

Campos de definição de filtro, where, include, order, offset, e limit - devem ser uma
string JSON-encoded ({"where":{"something":"value"}}).
Veja https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries
para maiores detalhes.

Tipostring

Respostas

Request was successful
JSON
{
"uuid": "616f411f-61e2-4f25-b3f6-75c872771818",
"name": "Api4Com API de Voz",
"email": "suporte@api4com.com",
"phone": "4833328530",
"role": "ADMIN",
"emailVerified": true,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"lastLoginAt": "2021-01-01T00:00:00Z"
}

Exemplos

cURL
curl -X GET \
'https://api.api4com.com/api/v1/users' \
 -H "Content-Type: application/json"
JavaScript
fetch('https://api.api4com.com/api/v1/users', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://api.api4com.com/api/v1/users';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://api.api4com.com/api/v1/users'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

Released under the MIT License.