> ## Documentation Index
> Fetch the complete documentation index at: https://partner.headout.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List all active cities

> <Warning>We are soon moving to **v2 APIs** and **v1** will be deprecated. Switch to **v2** using the version selector above.</Warning>

List all active cities where Headout experiences are available.



## OpenAPI

````yaml GET /api/public/v1/city/
openapi: 3.1.0
info:
  title: Headout API Docs
  version: 0.0.1
servers:
  - url: https://www.headout.com
    description: Production server
  - url: https://www.sandbox-headout.com
    description: Sandbox server
security: []
paths:
  /api/public/v1/city/:
    get:
      tags:
        - Cities
      summary: List all active cities
      description: >-
        <Warning>We are soon moving to **v2 APIs** and **v1** will be
        deprecated. Switch to **v2** using the version selector above.</Warning>


        List all active cities where Headout experiences are available.
      operationId: v1ListCities
      parameters:
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
          description: Number of items to skip before starting to collect the result set.
        - name: limit
          in: query
          schema:
            type: integer
            default: 10
          description: Maximum number of items to return.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCities'
              example:
                items:
                  - code: DUBAI
                    name: Dubai
                    image:
                      url: >-
                        //cdn-imgix.headout.com/media/images/7ceacca12e93245d25c59e5743b6c5d9-dubai-city-01.jpg
                nextUrl: https://www.headout.com/api/public/v1/city?offset=1&limit=1
                prevUrl: null
                total: 874
                nextOffset: 1
      security:
        - apiKeyAuth: []
      x-codeSamples:
        - lang: curl
          source: |
            curl --location 'https://www.headout.com/api/public/v1/city/' \
            --header 'Headout-Auth: <YOUR_API_KEY>'
components:
  schemas:
    PaginatedCities:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/City'
          description: The cities in this page of results.
        nextUrl:
          type:
            - string
            - 'null'
          description: >-
            Full URL to fetch the next page of results. Null if on the last
            page.
        prevUrl:
          type:
            - string
            - 'null'
          description: >-
            Full URL to fetch the previous page of results. Null if on the first
            page.
        total:
          type: integer
          description: Total number of cities across all pages.
        nextOffset:
          type:
            - integer
            - 'null'
          description: >-
            Offset value to use in the next request to retrieve the following
            page.
    City:
      type: object
      properties:
        code:
          type: string
          description: >-
            Uppercase city identifier used as a parameter in other API endpoints
            (e.g., `NEW_YORK`, `DUBAI`, `LONDON`). See [Cities
            API](/api-partner/v1/cities).
        name:
          type: string
          description: Human-readable city name for display.
        image:
          $ref: '#/components/schemas/Image'
          description: >-
            A representative city image for display in navigation or city
            selection UI.
    Image:
      type: object
      properties:
        url:
          type: string
          description: >-
            CDN URL for the image. Can be used with imgix parameters for
            resizing and format conversion.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Headout-Auth

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.