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

# List clusters

> Lists all clusters for the calling tenant, newest first.



## OpenAPI

````yaml /api-reference/energy-management/openapi.en.yaml GET /clusters
openapi: 3.1.0
info:
  title: RiDERgy Energy Management API
  version: '1.0'
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
  description: >
    Programmatic control of charging power limits across locations, individual

    chargers, organizations, and cross-location clusters.


    ## Authentication

    Every endpoint except `GET /health` requires an `x-api-key` header. The key

    determines your tenant — it is never read from the request body or any other

    header, so a key for one tenant cannot access another tenant's data.


    Your tenant must have the Energy Management API feature enabled, otherwise

    requests fail with `403 FEATURE_NOT_ENABLED`. Contact RiDERgy to enable it.


    ## Priority model

    Location and charger limits are controlled via **priority-windowed
    profiles**:


    - Priorities range from **0 (lowest) to 10 (highest)**, OCPP-stack-style.

    - A target (location or charger connector) can have up to 11 profiles, one
      per priority level, each with its own `[startTime, endTime)` window.
    - At any moment, the **effective limit** is the `limitKw` of the
      highest-priority profile whose window is currently active.
    - If no profile is active, a location falls back to its `permanentLimitKw`.

    - Submitting a profile at a priority that already has one for that target
      **replaces** it.
    - Profiles are applied and reverted automatically at their
      `startTime`/`endTime` — no further API calls are needed once a profile is
      created. Profile records are never deleted, so history remains queryable.

    ## Errors

    All errors share this shape:


    ```json

    {
      "error": {
        "code": "LOCATION_NOT_FOUND",
        "message": "Location 123 was not found for the provided tenant",
        "requestId": "b1f6e6b0-..."
      }
    }

    ```
servers:
  - url: https://api.ridergy.com/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Health
    description: Unauthenticated service health check.
  - name: Locations
    description: Read and set location-level power limits and priority profiles.
  - name: Chargers
    description: >-
      Lock individual charger connectors to a fixed power limit for a time
      window.
  - name: Organizations
    description: Tenant-wide cap profiles (recorded only — enforcement not yet active).
  - name: Clusters
    description: Group locations under a shared kW cap and apply schedules across them.
paths:
  /clusters:
    get:
      tags:
        - Clusters
      summary: List clusters
      description: Lists all clusters for the calling tenant, newest first.
      operationId: listClusters
      responses:
        '200':
          description: Clusters
          content:
            application/json:
              schema:
                type: object
                properties:
                  clusters:
                    type: array
                    items:
                      $ref: '#/components/schemas/Cluster'
                  count:
                    type: integer
                    example: 2
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotEnabled'
components:
  schemas:
    Cluster:
      type: object
      properties:
        clusterId:
          type: string
          example: clst_20260612_a1b2c3d4
        tenantUuid:
          type: string
        name:
          type: string
          example: North Campus
        locationIds:
          type: array
          items:
            type: string
          example:
            - '3632155'
            - '3632156'
        limitKw:
          type:
            - number
            - 'null'
          example: 200
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: LOCATION_NOT_FOUND
            message:
              type: string
              example: Location 123 was not found for the provided tenant
            requestId:
              type: string
              format: uuid
  responses:
    Unauthorized:
      description: Missing, invalid, or expired API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            unauthorized:
              value:
                error:
                  code: UNAUTHORIZED
                  message: Invalid or inactive API key
                  requestId: b1f6e6b0-1234-4abc-9def-000000000000
    FeatureNotEnabled:
      description: Tenant does not have the Energy Management API enabled
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            featureNotEnabled:
              value:
                error:
                  code: FEATURE_NOT_ENABLED
                  message: >-
                    The Energy Management API is not enabled for your account.
                    Contact RiDERgy to enable this feature.
                  requestId: b1f6e6b0-1234-4abc-9def-000000000000
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Per-tenant API key. Tenant is derived from the key — never from the
        request.

````