---
title: "List all Consumers"
method: GET
path: "/v2/control-planes/{controlPlaneId}/core-entities/consumers"
tags: ["Consumers"]
---

# List all Consumers

`GET /v2/control-planes/{controlPlaneId}/core-entities/consumers`

List all Consumers

## Query parameters

- `size` integer
- `offset` string
- `tags` string
- `custom_id` string
- `filter[name][contains]` string
- `filter[name][eq]` string

## Response `200`

A successful response listing Consumers

- object
  - `data` Consumer[]
    - `created_at` integer, nullable — Unix epoch when the resource was created.
    - `custom_id` string, nullable — Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.
    - `id` string, nullable — A string representing a UUID (universally unique identifier).
    - `tags` string[], nullable — An optional set of strings associated with the Consumer for grouping and filtering.
    - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
    - `username` string, nullable — The unique username of the Consumer. You must send either this field or `custom_id` with the request.
  - `next` string — URI to the next page (may be null)
  - `offset` string — Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

## Other responses

- `401` — Unauthorized

## Changes

- **2025-12-03** `581456e3279f` — 3 info
  - added the new optional `query` request parameter `custom_id`
  - added the new optional `query` request parameter `filter[name][contains]`
  - added the new optional `query` request parameter `filter[name][eq]`
- **2025-08-22** `3c0154b2053a` — 1 breaking
  - the response property `data` became nullable for the status `200`
- **2025-07-22** `76b0fefddb0d` — 1 breaking
  - the response property `data/items/tags` became nullable for the status `200`

[Change history](https://skmtc.dev/kong/apis/konnect-api-go-sdk/changes/v2/control-planes/:controlPlaneId/core-entities/consumers/get.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc.dev/kong/apis/konnect-api-go-sdk/revisions/de79e1192f11?raw)
