# consumers

query · in the family [Consumer](/reference/consumer/)

## What it does

The consumer list — each entry is a consumer profile — the shopper identity used by portals.

The caller's org-group family's ACTIVE LISTING of Consumers — doomed records DROP from listings. PAGINATED: `limit` clamps to \[1, 200], default 100; `nextToken` = the prior page's cursor, verbatim — opaque + tenant-bound (a malformed or foreign token → VALIDATION/INVALID). Walk until `nextToken` is null (a page may hold fewer than `limit` — doomed drop per page).

## What happens

Reads only — changes nothing.

## Who may call it

Capability area: **Reading your records** — Looking up and listing the records of your organization.

- Owner
- System Administrator
- Manager
- Associate Manager
- Sales Associate
- Cashier
- An API key whose scope allows `api:consumers`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `limit` | [Int](/types/#scalars) | no | How many records to answer at most; a page may hold fewer. |
| `nextToken` | [String](/types/#scalars) | no | The cursor from the previous page, passed back exactly as received. |

## Returns

[ConsumerPage](/types/ConsumerPage/) `ConsumerPage!` — One page of the consumers listing — the records + the opaque resume cursor.

This is a page: `items` holds the records and `nextToken` the cursor for the next page — pass it back verbatim until it is null. See [paging](/guides/paging-and-the-cursor-grammar/).

## Example request

```graphql
query ExampleConsumers($limit: Int) {
  consumers(limit: $limit) {
    items {
      id
      sysId
      type
      caption
      status
      parentId
      rootId
      createdAt
      updatedAt
      revisionNum
      revision
      email
      displayName
      phones
      priceGroupId
      tagIds
      locale
      displayCurrency
      dateOfBirth
      commsFrequency
      commsFormat
      commsTopics
      interests
      preferredLogicalFacilityId
    }
    nextToken
  }
}
```

Variables:

```json
{
  "limit": 1
}
```

## Example response

```json
{
  "data": {
    "consumers": {
      "items": [
        {
          "id": "01900000-0000-7000-8000-37386ae00000",
          "sysId": "CN-EXMP-0000-000F",
          "type": "Consumer",
          "caption": "Blue jeans",
          "status": "active",
          "parentId": "01900000-0000-7000-8000-065235280000",
          "rootId": "01900000-0000-7000-8000-a093dd800000",
          "createdAt": "2027-01-31T00:00:00.000Z",
          "updatedAt": "2027-01-31T00:00:00.000Z",
          "revisionNum": 1,
          "revision": "01900000-0000-7000-8000-b7960e180000",
          "email": "<the person’s email address>",
          "displayName": "Blue jeans",
          "phones": [
            "<phones>"
          ],
          "priceGroupId": "01900000-0000-7000-8000-c7ffbf680000",
          "tagIds": [
            "01900000-0000-7000-8000-decd62770000"
          ],
          "locale": "en-CA",
          "displayCurrency": "<display currency>",
          "dateOfBirth": "<date of birth>",
          "commsFrequency": "<comms frequency>",
          "commsFormat": "<comms format>",
          "commsTopics": [
            "<comms topics>"
          ],
          "interests": [
            "<interests>"
          ],
          "preferredLogicalFacilityId": "01900000-0000-7000-8000-23734f810000"
        }
      ],
      "nextToken": "<the cursor from the previous page>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))