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

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

# ListRealmConsumers

## 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
components:
  schemas:
    ConsumerWithRealm:
      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"
        realm_id:
          $ref: "#/components/schemas/UUID"
      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
        realm_id: 77fd4d02-5d87-4f76-90a9-1bd6ce152c36
      additionalProperties: false
      required:
        - id
        - username
        - custom_id
        - type
        - tags
        - consumer_groups
        - created_at
        - updated_at
        - realm_id
    CursorMeta:
      description: Pagination metadata.
      type: object
      properties:
        page:
          $ref: "#/components/schemas/CursorMetaPage"
      required:
        - page
    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
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      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
    ListRealmConsumers:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ConsumerWithRealm"
        meta:
          $ref: "#/components/schemas/CursorMeta"
      required:
        - data
        - meta
```
