Entrar

Listar clientes

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

Devuelve la lista paginada de clientes, y es también cómo se busca un cliente por correo, documento o teléfono — se filtra el listado, en vez de llamar a un endpoint aparte, porque endpoint aparte no existe.

El filtro usa la gramática común de listado q[columna][operador]=valor, documentada por completo en Parámetros de listado. Cualquier columna de la respuesta puede filtrarse.

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

E es igualdad exacta — el operador para cuando ya se tiene la dirección. LRL es "contiene", útil en búsqueda parcial. Las columnas se combinan.

El endpoint es solo de lectura. Para resolver un identificador y crear el cliente si no existe, la operación es otra (Buscar o crear cliente) y escribe — no la uses solo para consultar.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

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

Encabezados

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`.

Respuestas

{
    "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