---
title: "List consumers"
url: "https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317/operations/list-consumers-per-realm"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317.md

# List consumers

`GET` `/realms/{realmId}/consumers`

Operation ID: `list-consumers-per-realm`

List all consumers that are a member of this realm.

## Path parameters

- `realmId` (string, uuid, required) - ID of the realm

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[before]` (string, optional) - Request the next page of data, starting with the item before this parameter.
- `page[after]` (string, optional) - Request the next page of data, starting with the item after this parameter.
- `filter` (object, optional) - Filters Consumers in the response.

## Responses

- `200` - success
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Centrally Managed Consumers admin api
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /realms/{realmId}/consumers:
    parameters:
      - $ref: "#/components/parameters/realmId"
    get:
      operationId: list-consumers-per-realm
      summary: List consumers
      description: |
        List all consumers that are a member of this realm. 
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageBefore"
        - $ref: "#/components/parameters/PageAfter"
        - $ref: "#/components/parameters/ConsumerFilters"
      responses:
        "200":
          description: success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListConsumers"
              examples:
                ListConsumers:
                  $ref: "#/components/examples/ListConsumers"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Centrally Managed Consumers
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
components:
  parameters:
    realmId:
      name: realmId
      in: path
      required: true
      description: ID of the realm
      schema:
        type: string
        format: uuid
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageBefore:
      name: page[before]
      description: Request the next page of data, starting with the item before this
        parameter.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: string
        example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
    PageAfter:
      name: page[after]
      description: Request the next page of data, starting with the item after this
        parameter.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: string
        example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
    ConsumerFilters:
      name: filter
      description: Filters Consumers in the response.
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/ConsumerFilterParameters"
      style: deepObject
  schemas:
    ListConsumers:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/CentralizedConsumer"
        meta:
          $ref: "#/components/schemas/CursorMeta"
      required:
        - data
        - meta
    ConsumerFilterParameters:
      type: object
      properties:
        custom_id:
          description: "Filter using **one** of the following operators: `eq`"
          properties:
            eq:
              description: The field exactly matches the provided value.
              type: string
              example: ?filter[field_name_here][eq]=foo
          x-examples:
            example-1: equals-some-value
            example-2:
              eq: some-value
        username:
          description: "Filter using **one** of the following operators: `eq`"
          properties:
            eq:
              description: The field exactly matches the provided value.
              type: string
              example: ?filter[field_name_here][eq]=foo
          x-examples:
            example-1: equals-some-value
            example-2:
              eq: some-value
    CentralizedConsumer:
      description: The Consumer object represents a consumer - or a user - of a
        Service. You can either rely on Kong as the primary datastore, or you
        can map the consumer list with your database to keep consistency between
        Kong and your existing primary datastore.
      type: object
      properties:
        id:
          description: The Consumer ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        username:
          description: The unique username of the Consumer. You must send either this
            field or `custom_id` with the request.
          type: string
          nullable: true
        custom_id:
          description: 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.
          type: string
          nullable: true
        type:
          $ref: "#/components/schemas/ConsumerType"
        tags:
          $ref: "#/components/schemas/Tags"
        consumer_groups:
          $ref: "#/components/schemas/ConsumerGroups"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      example:
        custom_id: "4200"
        id: 8a388226-80e8-4027-a486-25e4f7db5d21
        type: proxy
        consumer_groups:
          - gold
        tags:
          - partner
        username: bob-the-builder
        created_at: 2025-06-17T16:55:58.569399532Z
        updated_at: 2025-06-17T16:55:58.569399532Z
      additionalProperties: false
      required:
        - id
        - username
        - custom_id
        - type
        - tags
        - consumer_groups
        - created_at
        - updated_at
    CursorMeta:
      description: Pagination metadata.
      type: object
      properties:
        page:
          $ref: "#/components/schemas/CursorMetaPage"
      required:
        - page
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ConsumerType:
      description: |
        Type of the consumer.
      type: string
      default: proxy
      enum:
        - proxy
        - developer
        - admin
        - application
    Tags:
      type: array
      items:
        type: string
      uniqueItems: true
    ConsumerGroups:
      description: >
        A list of consumer groups that the Consumer is in.

        If `consumer_groups` are provided on the Consumer object _and_ on the
        Realm, the Consumer will be placed in all defined consumer groups.
      type: array
      items:
        type: string
        uniqueItems: true
      title: ConsumerGroups
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    CursorMetaPage:
      type: object
      properties:
        first:
          description: URI to the first page
          type: string
          format: path
        last:
          description: URI to the last page
          type: string
          format: path
        next:
          description: URI to the next page
          type: string
          format: path
          nullable: true
        previous:
          description: URI to the previous page
          type: string
          format: path
          nullable: true
        size:
          description: Requested page size
          type: number
          example: 10
      required:
        - size
        - next
        - previous
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    ListConsumers:
      value:
        data:
          - id: 2cec70a4-d197-495c-8f3e-c0a1199d1da4
            username: Bob
            custom_id: Dyl4N
            type: application
            tags:
              - one
              - two
            consumer_groups:
              - gold
              - silver
            created_at: 2023-03-20T09:29:14.52Z
            updated_at: 2023-03-21T09:29:14.52Z
        meta:
          page:
            size: 1
            previous: null
            next: /v1/realms/4e410025-b357-4cf1-82e1-4871f3f43532/consumers?page%5Bafter%5D=f1kZXVdYF0VFUEcBGA1%2BGUEAMV5CDBRYSlwKUF9fHRREQ10XFQ%3D%3D
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  securitySchemes:
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
