---
title: "List group requests"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/operations/listGroupRequests"
---

> Full API specification: https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78.md

# List group requests

`GET` `/group-requests`

Operation ID: `listGroupRequests`

## Query parameters

- `status` (string, optional)
- `per_page` (integer, optional)
- `cursor` (string, optional) - Opaque cursor from `meta.next_cursor` / `links.next`.

## Responses

- `200` - A page of group requests.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Kong Hotels Partner API
  version: 1.0.0
servers:
  - url: https://api.konghotels.cloud
    description: Kong Gateway
paths:
  /group-requests:
    get:
      tags:
        - Group Requests
      operationId: listGroupRequests
      summary: List group requests
      parameters:
        - name: status
          in: query
          schema:
            $ref: "#/components/schemas/GroupRequestStatus"
        - $ref: "#/components/parameters/PerPage"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: A page of group requests.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/CursorPage"
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/GroupRequest"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  schemas:
    GroupRequestStatus:
      type: string
      enum:
        - received
        - under_review
        - proposal_sent
        - accepted
        - declined
        - cancelled
    CursorPage:
      type: object
      properties:
        links:
          type: object
          properties:
            first:
              type:
                - string
                - "null"
            last:
              type:
                - string
                - "null"
            prev:
              type:
                - string
                - "null"
            next:
              type:
                - string
                - "null"
        meta:
          type: object
          properties:
            path:
              type: string
            per_page:
              type: integer
            next_cursor:
              type:
                - string
                - "null"
            prev_cursor:
              type:
                - string
                - "null"
    GroupRequest:
      allOf:
        - type: object
          properties:
            reference:
              type: string
              examples:
                - GRP-8K2M4Q
            status:
              $ref: "#/components/schemas/GroupRequestStatus"
            property_code:
              type: string
            currency:
              type: string
            cancelled_at:
              type:
                - string
                - "null"
              format: date-time
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
        - $ref: "#/components/schemas/GroupRequestFields"
    GroupRequestFields:
      type: object
      properties:
        event_type:
          type: string
          enum:
            - corporate
            - conference
            - wedding
            - sports_team
            - tour_group
            - other
        group_name:
          type: string
        contact:
          type: object
          required:
            - name
            - email
          properties:
            name:
              type: string
            email:
              type: string
              format: email
            phone:
              type:
                - string
                - "null"
            organisation:
              type:
                - string
                - "null"
        check_in:
          type: string
          format: date
        check_out:
          type: string
          format: date
          description: At most 30 nights after check_in.
        rooms_requested:
          type: integer
          minimum: 10
          maximum: 500
        attendees:
          type:
            - integer
            - "null"
        room_preferences:
          type: array
          items:
            type: object
            required:
              - room_type_code
              - rooms
            properties:
              room_type_code:
                type: string
              rooms:
                type: integer
        needs_meeting_space:
          type: boolean
          default: false
        budget_per_night:
          type:
            - number
            - "null"
          description: Per room
          in the property currency.: null
        notes:
          type:
            - string
            - "null"
  parameters:
    PerPage:
      name: per_page
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
    Cursor:
      name: cursor
      in: query
      description: Opaque cursor from `meta.next_cursor` / `links.next`.
      schema:
        type: string
  securitySchemes:
    KongKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your API key, validated by Kong Gateway. The header name depends on
        the gateway's key-auth configuration.
    KongConsumer:
      type: apiKey
      in: header
      name: X-Consumer-ID
      description: "**Local development only.** Simulates the consumer identity Kong
        Gateway injects after authentication."
```