Listar Clientes (Sub-contas)
Retorna a lista de clientes (sub-contas). Retorna no máximo 500 usuários.
Requisição HTTP
| Método | Caminho (Path) |
|---|---|
GET | /api/user/list |
Parâmetros de Consulta (Query)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
access_token | string | true | O token de acesso. |
account | string | false | Nome da conta pai para filtrar os sub-clientes. |
Exemplo
Request URL:
GET https://api.brasilsatgps.com.br/api/user/list?access_token={ACCESS_TOKEN}&account=demoEstrutura de Retorno (Schema)
| Campo JSON | Tipo de Dado | Descrição |
|---|---|---|
record | Array | Lista de objetos de contas de sub-clientes. |
record[].account | string | Nome de login da conta. |
record[].username | string | Nome do usuário. |
record[].email | string | Endereço de e-mail. |
record[].mobile | string | Número de telefone celular. |
record[].telephone | string | Número de telefone fixo. |
record[].contact | string | Nome da pessoa de contato. |
record[].createtime | long | Data de criação (carimbo de data/hora UNIX em segundos). |
record[].roletype | int | Tipo de cargo/perfil: 1 (Distribuidor), 2 (Cliente final), 3 (Conta virtual). |
record[].blockstatus | int | Status de bloqueio: 0 (Bloqueado), 1 (Desbloqueado). |
record[].hassubcustomer | boolean | Se o sub-cliente também possui os seus próprios sub-clientes (true ou false). |
record[].zipcode | string | Código postal (CEP). |
record[].remark | string | Observação/comentário. |
Exemplo de Resposta JSON
{
"code": 0,
"record": [
{
"createtime": 1562570435,
"mobile": "",
"telephone": "",
"contact": "",
"roletype": 1,
"account": "demo",
"email": "openapidemo@gmail.com",
"blockstatus": 1,
"username": "openapidemo",
"hassubcustomer": true,
"zipcode": "ZIP-10001",
"remark": ""
},
{
"createtime": 1562670132,
"mobile": "",
"telephone": "",
"contact": "",
"roletype": 1,
"account": "demotest",
"email": "demotest@gmail.com",
"blockstatus": 1,
"username": "demotest name",
"hassubcustomer": false,
"zipcode": "ZIP-10001",
"remark": ""
}
]
}