Sign in

List Customers

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

Returns a paginated list of customers, and is also how you look a customer up by e-mail, document or phone — filter the listing instead of calling a separate endpoint, because there is no separate endpoint.

Filtering uses the shared listing grammar q[column][operator]=value, documented in full under List query parameters. Any column of the response can be filtered.

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

E is exact match — the one to use when you already have the address in hand. LRL is "contains", useful for partial searches. Combine columns freely.

The endpoint is read-only. To resolve an identifier and create the customer if missing, that is a different operation (Get or create customer) and it writes — do not reach for it just to look someone up.

Try-it values populated from environment ACME (Demo)


Authentication

Token

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

Headers

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.

Query parameters

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

Responses

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