> ## Documentation Index > Fetch the complete documentation index at: https://developers.telluspowergroup.com/llms.txt > Use this file to discover all available pages before exploring further. # List sites > Retrieves a list of sites accessible to the authenticated client. ## OpenAPI ````yaml /api-reference/openapi.json get /operator/sites openapi: 3.1.0 info: title: Tellus Open Platform API version: 1.3.0 summary: Charger-platform integration API for CPMS, EMS, aggregators, and chargers. description: > The Tellus Open Platform API enables Charging Point Management Systems (CPMS), Energy Management Systems (EMS), aggregators and chargers themselves to integrate with the Tellus charging-platform infrastructure. The API is divided into three logical surfaces: - **Operator-side API** (`/v1/operator/...`) — used by CPMS, EMS, and aggregators to query the fleet, retrieve charging records, control chargers, schedule charging, issue load-flexibility commands, and subscribe to a real-time telemetry WebSocket. - **Charger-side API** (`/v1/device/...`) — used by chargers themselves for registration, heartbeat, telemetry, event reporting, charging-record upload, command fetching (long-polling), command-status reporting, and firmware-upgrade status. - **Operator-to-operator interop (legacy)** — an older roaming-style interface (PascalCase, PUT-based) used for data exchange between operator platforms, modelled after China's national charging-interop standard. Most modern partners should integrate via the Operator-side API instead. All requests use HTTPS (TLS 1.2 or higher). Plain HTTP is not supported. All bodies are `application/json`. Timestamps are ISO 8601 UTC. Energy is in kWh, power in kW, current in A, voltage in V, temperature in °C, and SOC is an integer percentage 0–100. Optional request signing using HMAC-SHA256 is supported for high-security operations (see §2.2.4 of the v1.3 specification). contact: name: Tellus Power — Platform Team url: https://www.telluspowergroup.com license: name: Proprietary — Tellus Power Group servers: - url: https://api.telluspower.example.com/v1 description: > Production (HOSTNAME PENDING). The v1.3 specification uses `api.chargingplatform.com` as a placeholder; the real production hostname has not yet been confirmed by the developer team. - url: https://api-test.telluspower.example.com/v1 description: | Test / Sandbox (HOSTNAME PENDING). To be confirmed by the developer team. security: [] tags: - name: Operator — Authentication description: OAuth2 client-credentials grant for CPMS / EMS / Aggregator integrations. - name: Operator — Sites & Devices description: >- Read-only resource queries — sites accessible to the authenticated client, and per-device detail with connector states. - name: Operator — Remote Control description: >- Initiate charging, stop charging, V2G discharge, and set charging schedules remotely. - name: Operator — Charging Records description: Historical session data (CDR — Charging Detail Records). - name: Operator — Energy & Flexibility description: >- Aggregated energy time-series and load-flexibility / demand-response control. - name: Operator — Commands description: Track execution of issued commands. - name: Operator — Telemetry Stream (WebSocket) description: >- Real-time telemetry subscription via WebSocket. Documented here for reference; the connection is established outside the OpenAPI request/response model. - name: Charger — Provisioning description: First-time device registration and access-token issuance. - name: Charger — Reporting description: Heartbeat, real-time telemetry, event reporting, charging-record upload. - name: Charger — Commands description: Long-polling for pending commands and reporting their execution status. - name: Charger — Firmware description: Firmware upgrade status reporting. - name: Operator-to-operator (legacy interop) description: | Older roaming-style interface (PascalCase fields, PUT methods) used for data exchange between operator platforms. Modern partners should normally integrate via the Operator-side API instead. externalDocs: description: >- Tellus Power developer documentation — guides, diagnostics, runbooks, and proposed API extensions url: https://developers.telluspowergroup.com paths: /operator/sites: get: tags: - Operator — Sites & Devices summary: List sites description: Retrieves a list of sites accessible to the authenticated client. parameters: - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' - name: status in: query schema: type: string enum: - active - inactive description: Optional filter by site status. responses: '200': description: Sites returned. content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiEnvelope' properties: data: $ref: '#/components/schemas/SitePage' example: code: 0 message: success data: total: 50 page: 1 size: 20 items: - site_id: site_001 name: Sunshine Charging Station address: 1 Sunshine Road, Beijing location: lat: 39.9042 lng: 116.4074 total_connectors: 10 status_summary: idle: 5 charging: 3 fault: 2 power_capacity: 100 created_at: '2024-01-01T00:00:00Z' security: - operatorOAuth2: - read components: parameters: PageNumber: name: page in: query schema: type: integer minimum: 1 default: 1 description: Page number (1-indexed). PageSize: name: size in: query schema: type: integer minimum: 1 maximum: 100 default: 20 description: Results per page (max 100). schemas: ApiEnvelope: type: object description: | Standard response envelope. `code` is `0` on success and a non-zero application code on error (see Error Codes — §14). required: - code - message properties: code: type: integer description: 0 = success; otherwise an error code per the Error Codes section. message: type: string description: Human-readable description. data: description: Endpoint-specific payload. SitePage: allOf: - $ref: '#/components/schemas/PageMeta' properties: items: type: array items: $ref: '#/components/schemas/Site' PageMeta: type: object properties: total: type: integer description: Total matching records. page: type: integer size: type: integer Site: type: object required: - site_id - name properties: site_id: type: string description: Unique site identifier. name: type: string address: type: string location: $ref: '#/components/schemas/Location' total_connectors: type: integer minimum: 0 status_summary: $ref: '#/components/schemas/SiteStatusSummary' power_capacity: type: number description: Total installed power capacity (kW). created_at: type: string format: date-time example: site_id: site_001 name: Sunshine Charging Station address: 1 Sunshine Road, Beijing location: lat: 39.9042 lng: 116.4074 total_connectors: 10 status_summary: idle: 5 charging: 3 fault: 2 power_capacity: 100 created_at: '2024-01-01T00:00:00Z' Location: type: object required: - lat - lng properties: lat: type: number format: double minimum: -90 maximum: 90 lng: type: number format: double minimum: -180 maximum: 180 SiteStatusSummary: type: object description: Counts of connectors at the site by current state. properties: idle: type: integer minimum: 0 charging: type: integer minimum: 0 fault: type: integer minimum: 0 securitySchemes: operatorOAuth2: type: oauth2 description: | OAuth2 client-credentials grant for operator-side integrations. Obtain an access token by POSTing `client_id` and `client_secret` to `/v1/operator/oauth/token`. Tokens are valid for 24 hours (86,400 seconds). flows: clientCredentials: tokenUrl: /v1/operator/oauth/token scopes: read: >- Read-only access to sites, devices, charging records, telemetry, and aggregated energy. write: >- Write access — remote start, stop, discharge, schedule, flexibility commands. ````