Entrar

Listar clientes

GET https://{organization}.myguper.com/api/register/customer

Retorna a lista paginada de clientes, e é também como se busca um cliente por e-mail, documento ou telefone — filtra-se a listagem, em vez de chamar um endpoint separado, porque endpoint separado não existe.

O filtro usa a gramática comum de listagem q[coluna][operador]=valor, documentada por inteiro em Parâmetros de listagem. Qualquer coluna da resposta pode ser filtrada.

GET /api/register/customer?q[email][E]=fulano@exemplo.com
GET /api/register/customer?q[document][E]=12345678900
GET /api/register/customer?q[email][LRL]=gmail&e=20

E é igualdade exata — o operador para quando já se tem o endereço em mãos. LRL é "contém", útil em busca parcial. As colunas podem ser combinadas.

O endpoint é somente leitura. Para resolver um identificador e criar o cliente se não existir, a operação é outra (Buscar ou criar cliente) e ela escreve — não use só para consultar.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros de query

Name Type Description
q object Filters, as `q[column][operator]=value`. Pass as a map of column to operator to value — for example `{"email": {"E": "someone@example.com"}}`. Operators include `E` (equals), `LRL` (contains), `RL` (starts with), `IN` (one of), `IS` (is null). Full table in the List query parameters guide.
p integer Page number, starting at 1.
e integer Entries per page. Defaults to 50.
o object Ordering, as `o[column]=ASC|DESC`.

Respostas

{
    "list": [
        {
            "id": 536813,
            "entityType": "individual",
            "name": "Rodrigo Dechen",
            "email": "rodrigo@gmail.com",
            "countryCallingCode": 55,
            "cellphone": "11987654321",
            "document": null,
            "gender": null,
            "dateOfBirth": null,
            "createdAt": "2024-03-11T09:20:41-03:00",
            "updatedAt": "2026-02-02T18:05:12-03:00"
        }
    ],
    "total": 1
}
Copied to clipboard