---
title: "List AI Gateway Consumers"
url: "https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3/operations/list-ai-gateway-consumers"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3.md

# List AI Gateway Consumers

`GET` `/ai-gateways/{gatewayId}/consumers`

Operation ID: `list-ai-gateway-consumers`

Returns a list of all consumers for the AI Gateway.

## Path parameters

- `gatewayId` (string, uuid, required) - The unique ID of the AI Gateway.

## 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[after]` (string, optional) - Request the next page of data, starting with the item after this parameter.

## Responses

- `200` - A paginated list of AI Gateway Consumers.
- `401` - Unauthorized
- `403` - Forbidden
- `429` - Too Many Requests

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect AI Gateway
  version: 0.0.0
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:
  /ai-gateways/{gatewayId}/consumers:
    parameters:
      - $ref: "#/components/parameters/AIGatewayId"
    get:
      operationId: list-ai-gateway-consumers
      summary: List AI Gateway Consumers
      description: Returns a list of all consumers for the AI Gateway.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageAfter"
      responses:
        "200":
          $ref: "#/components/responses/ListAIGatewayConsumersResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      tags:
        - AI Gateway Consumers
security:
  - konnectAccessToken: []
components:
  parameters:
    AIGatewayId:
      name: gatewayId
      in: path
      required: true
      description: The unique ID of the AI Gateway.
      example: bf138ba2-c9b1-4229-b268-04d9d8a6410b
      schema:
        $ref: "#/components/schemas/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
    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
  responses:
    ListAIGatewayConsumersResponse:
      description: A paginated list of AI Gateway Consumers.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: "#/components/schemas/AIGatewayConsumer"
              meta:
                $ref: "#/components/schemas/CursorMeta"
            required:
              - data
              - meta
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    TooManyRequests:
      description: Too Many Requests
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/TooManyRequestsError"
  schemas:
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    AIGatewayConsumer:
      type: object
      properties:
        display_name:
          description: The display name for this consumer instance.
          type: string
          example: Greg's Dev Key
        ref:
          description: A user-defined unique identifier for this consumer, used as a
            stable human-readable reference.
          type: string
          example: gregs-dev-key
        type:
          description: The type of the consumer.
          type: string
          enum:
            - apikey
            - oauth
        consumer_groups:
          description: List of AI Consumer Groups this consumer belongs to.
          type: array
          items:
            $ref: "#/components/schemas/AIGatewayConsumerGroupReference"
        policies:
          type: array
          items:
            $ref: "#/components/schemas/AIGatewayPolicyReference"
        config:
          description: Configuration for the consumer.
          type: object
          additionalProperties: false
          properties:
            custom_id:
              description: External mapping ID (e.g., OIDC Client ID).
              type: string
              example: 0oatibf4t2PlDxqgR1d7
              nullable: true
            credentials:
              description: List of credentials for this consumer.
              type: array
              items:
                type: object
                additionalProperties: false
                description: Sensitive credential data (e.g., API key value).
                required:
                  - api_key
                properties:
                  api_key:
                    type: string
                    example: sk-387788hd3xnej
                  ttl:
                    description: The API Key's time-to-live in seconds.
                    type: integer
                    example: 86400
        labels:
          $ref: "#/components/schemas/PublicLabels"
        managed_by:
          $ref: "#/components/schemas/AIGatewayManagedBy"
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: true
      required:
        - display_name
        - ref
        - type
        - config
        - consumer_groups
        - policies
        - id
        - created_at
        - updated_at
    CursorMeta:
      description: Pagination metadata.
      type: object
      properties:
        page:
          $ref: "#/components/schemas/CursorMetaPage"
      required:
        - page
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    TooManyRequestsError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 429
            title:
              example: Too Many Requests
            type:
              example: https://httpstatuses.com/429
            instance:
              example: kong:trace:1234567890
            detail:
              example: Too Many Requests
    AIGatewayConsumerGroupReference:
      description: Lightweight object used to reference a consumer group, identified
        by its `ref`.
      type: object
      properties:
        ref:
          description: The user-defined unique identifier for a consumer group.
          type: string
          example: dev-users
      additionalProperties: false
      required:
        - ref
    AIGatewayPolicyReference:
      description: Lightweight object used to reference a policy instance, identified
        by its `ref`.
      type: object
      properties:
        ref:
          description: The user-defined unique identifier for a policy instance.
          type: string
          example: ai-pii-sanitizer-1234
      additionalProperties: false
      required:
        - ref
    PublicLabels:
      description: >
        Public labels store information about an entity that can be used for
        filtering a list of objects.


        Public labels are intended to store **PUBLIC** metadata. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        category: finance
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: PublicLabels
    AIGatewayManagedBy:
      description: >
        Indicates the managing entities for a resource. A maximum of 5 keys is
        allowed.


        Keys must be 63 characters or less, starting and ending with an
        alphanumeric character,

        and may include dashes (-), underscores (_), and dots (.).


        Values must be non-empty strings of 127 characters or less.


        Keys and values must not contain spaces or control characters, and are
        case-insensitive.
      type: object
      example:
        team: platform
        owner: kong
      additionalProperties:
        type: string
        minLength: 1
        maxLength: 127
      maxProperties: 5
      nullable: true
    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:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    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.
```
