---
title: "List Consumers"
method: GET
path: "/api/v1/gtm/consumers/"
tags: ["GTM - Consumers"]
---

# List Consumers

`GET /api/v1/gtm/consumers/`

## Request

- Base URL: `https://api.gemstoneaiapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemstoneaiapp.com/api/v1/gtm/consumers/`
- Auth: none declared

## Query parameters

- `status` string, nullable: paid|free|churned|trialing
- `search` string, nullable: email / name / mobile
- `sort` string: signup_desc|signup_asc|last_scan_desc|mrr_desc
- `page` integer
- `page_size` integer

## Headers

- `x-admin-key` string, nullable

## Response `200`

Successful Response

- ConsumerListResponse
  - `total` integer, required
  - `page` integer, required
  - `page_size` integer, required
  - `items` ConsumerListItem[], required
    - `user_id` integer, required
    - `full_name` string, required
    - `email` string, nullable
    - `mobile_number` string, nullable
    - `auth_provider` string, nullable
    - `member_since` string, date-time, nullable
    - `status` string, required
    - `plan_name` string, nullable
    - `plan_display_name` string, nullable
    - `billing_period` string, nullable
    - `mrr_cents` integer
    - `scans_used_this_month` integer
    - `scan_count_total` integer
    - `collection_size` integer
    - `last_scan_at` string, date-time, nullable
    - `current_period_end` string, date-time, nullable
    - `cancel_at_period_end` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api.md) · [All operations](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/revisions/fcb441f55161?raw)