---
title: "List hot coffee options"
url: "https://devportal.jilson.dev/apis/coffee-api-basic-auth-1/versions/fda4cb4b-55ba-4429-adda-18b0f29a2ef0/operations/listHotCoffees"
---

> Full API specification: https://devportal.jilson.dev/apis/coffee-api-basic-auth-1/versions/fda4cb4b-55ba-4429-adda-18b0f29a2ef0.md

# List hot coffee options

`GET` `/coffee/hot`

Operation ID: `listHotCoffees`

Retrieves a list of available hot coffee options with pagination.

## Query parameters

- `limit` (integer, int32, optional) - Maximum number of items to return per page
- `offset` (integer, int32, optional) - Number of items to skip for pagination

## Responses

- `200` - Successful operation

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Coffee API
  version: 1.0.0
servers:
  - url: https://kong-a854e05124usljo2h.kongcloud.dev/
    description: Main server
paths:
  /coffee/hot:
    get:
      summary: List hot coffee options
      description: Retrieves a list of available hot coffee options with pagination.
      operationId: listHotCoffees
      tags:
        - coffee
      parameters:
        - name: limit
          in: query
          description: Maximum number of items to return per page
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 100
            default: 20
        - name: offset
          in: query
          description: Number of items to skip for pagination
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/Coffee"
                  meta:
                    type: object
                    properties:
                      page:
                        type: object
                        properties:
                          limit:
                            type: integer
                            description: Number of items per page
                            example: 20
                          offset:
                            type: integer
                            description: Index of the first item in the current page
                            example: 0
                          total:
                            type: integer
                            description: Total number of items available
                            example: 100
                          estimated_total:
                            type: boolean
                            description: Indicates if the total is an estimate
                            example: true
      security:
        - basicAuth: []
security:
  - basicAuth: []
components:
  schemas:
    Coffee:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the coffee
          example: a1b2c3d4-e5f6-7890-1234-567890abcdef
        name:
          type: string
          description: Name of the coffee
          example: Latte
        description:
          type: string
          description: Description of the coffee
          example: Rich and creamy coffee with steamed milk
        price:
          type: number
          format: float
          description: Price of the coffee
          example: 3.5
      required:
        - id
        - name
        - description
        - price
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
```
