> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a Connect session > Retrieves a Connect session. ## OpenAPI ````yaml energy-api/reference/flatpeak-api-spec-energy-tariffs.json GET /connect-sessions/{session_id} openapi: 3.0.3 info: description: >- The tariff functions of the Flatpeak Energy API: tariff connection, prices, forecasts and costs. Generated from the full Energy API spec by scripts/build-tariff-spec.py. Do not edit. version: 2027-01-01.busbar title: 'Flatpeak Energy API: Tariffs' termsOfService: https://flatpeak.com/legal contact: name: Technical Support email: support@flatpeak.com url: https://flatpeak.com/contact license: name: Apache 2.0 url: https://flatpeak.com/legal servers: - url: https://energy-api.flatpeak.com security: - bearerAuth: [] tags: - name: Authentication description: >- Exchange your account credentials for a bearer token to authenticate API requests. - name: Connect description: >- Create and retrieve Connect sessions. Connect drives the user journeys for tariff connection and [tariff error reporting](/energy-api/reference/connect/tariff/error-report). What happens in those journeys reaches your backend as [Connect webhooks](/energy-api/guides/platform/events). - name: Users description: Create, retrieve, update, delete, and list users. - name: Locations description: Create, retrieve, update, delete, and list locations. - name: Devices description: >- Create, retrieve, update, delete and list devices; submit and retrieve their state; read and write their shared settings. - name: Meters description: Submit meter records and check batch status. - name: Tariffs description: Create, retrieve, delete, and list tariffs. - name: Prices description: Retrieve and audit calculated energy prices. - name: Costs description: Calculate the monetary cost of imported or exported energy. - name: Optimizations description: >- Rank the connected tariff to find the best times to consume or export energy, as inputs to your own scheduling. - name: Events description: Retrieve and list account events. externalDocs: description: Documentation url: https://docs.flatpeak.com paths: /connect-sessions/{session_id}: parameters: - schema: type: string name: session_id in: path required: true description: Flatpeak Connect session ID. get: tags: - Connect summary: Retrieve a Connect session description: Retrieves a Connect session. operationId: get-connect-session parameters: [] responses: '200': $ref: '#/components/responses/ConnectSession' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' components: responses: '401': description: '401 Unauthorized: authentication credentials are missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: '403 Forbidden: you do not have permission to access this resource.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '404 Not Found: the requested resource does not exist.' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '429 Too Many Requests: the rate limit has been exceeded.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: >- 500 Internal Server Error: an unexpected error occurred. Safe to retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- 503 Service Unavailable: the service is temporarily down for maintenance. Retry after the indicated delay. content: application/json: schema: $ref: '#/components/schemas/Error' ConnectSession: description: Connect session response. content: application/json: schema: type: object properties: id: type: string description: Flatpeak Connect session ID. example: cos_6a3196d6e61a44f33f7307ed object: type: string description: Object type. example: connect_session live_mode: type: boolean description: '`true` for live data, `false` for test data.' example: true device_id: type: string description: Flatpeak Device ID. example: dev_63a6087272941ef077a8fd3e location_id: type: string description: Flatpeak Location ID. example: loc_641b90b758fb8e6293716e40 supplier_id: type: string description: >- Flatpeak ID of the energy supplier preselected for the `TARIFF` flow, when one was passed. example: sup_6a2b2460ba2259a0c4980afb connect_url: type: string example: myapp://nova/flatpeak/connect description: >- URL the user is redirected to during the **Handling the callback** step of the [Redirect](/energy-api/reference/connect/tariff/redirects) function: your Connect web app or a deep link into your native app. callback_url: type: string example: myapp://nova/flatpeak/complete description: >- URL to redirect the user to after they complete or exit their Connect session. time_created: type: string description: Time when the object was created, in UTC. example: '2026-05-05T18:37:27Z' format: date-time time_expiry: type: string example: '2026-12-28T03:00:00Z' description: Time when the session expires. format: date-time price_available: type: boolean description: '`true` when prices are available to fetch.' required: - id - object - live_mode - location_id - time_created - time_expiry - price_available schemas: Error: type: object description: Standard error envelope returned by every non-2xx response. required: - object - type - code - message properties: object: type: string enum: - error default: error description: Object type. type: type: string description: High-level error category. example: invalid_request code: type: string description: Machine-readable error code, safe to branch on. example: not_found message: type: string description: Human-readable description of the error. example: The requested resource could not be found. context: type: string description: Optional originating context, for example `api.price_get`. example: api.price_get live_mode: type: boolean description: Whether the error occurred against live or test data. time_created: type: string format: date-time description: Time the error was generated (RFC 3339). example: '2026-01-01T00:00:00Z' securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer token obtained from POST /auth/tokens. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.