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

# Get connector



## OpenAPI

````yaml /api-reference/nexus/nexus-api-oas.json get /stations/{stationId}/chargers/{chargerId}/connectors/{connectorId}
openapi: 3.0.3
info:
  title: Nexus API
  description: >-
    The Nexus API provides access to charging stations, chargers, connectors,
    tariffs, customers, and charging sessions for partner backend integrations.


    ## Integration model


    This API is designed for server-to-server use. End-user applications should
    access this data through the partner backend rather than calling these
    endpoints directly.


    ## Authentication


    Every request must include an `x-api-key` header containing a valid API key.
    Missing or unrecognized API keys are rejected with `401 Unauthorized`.


    ## IDs


    Stations, chargers, and tariffs use `id` as their public stable identifier.
    These identifiers are exactly 8 alphanumeric characters. Customers use `id`,
    an opaque identifier supplied by the partner system. Sessions use a numeric
    session ID. Connector IDs are 1-based positive integers within a charger;
    invalid connector path values return `404 Not Found`.


    ## Tariffs


    Tariffs use a structured pricing model with elements, price components, and
    optional restrictions. `tariffId` response fields reference public tariff
    identifiers and are omitted when no tariff applies.


    ## Pagination


    Paginated collection endpoints accept `limit` and `offset` query parameters.
    Missing, non-integer, zero, or negative `limit` values use the default limit
    of 100; values above 100 are clamped to 100. Missing, non-integer, or
    negative `offset` values use 0. The response body includes a `links` object
    with `next` and `prev` URLs. A link is `null` when that page does not exist.
    The total result count is returned in the `X-Total-Count` response header.
  version: 1.0.0
servers:
  - url: https://{host}/v1
    description: Environment-specific Nexus API base URL.
    variables:
      host:
        default: api.example.com
        description: Nexus API host provided during onboarding.
security:
  - ApiKeyAuth: []
tags:
  - name: Stations
  - name: Chargers
  - name: Connectors
  - name: Tariffs
  - name: Customers
  - name: Sessions
paths:
  /stations/{stationId}/chargers/{chargerId}/connectors/{connectorId}:
    get:
      tags:
        - Connectors
      summary: Get connector
      parameters:
        - $ref: '#/components/parameters/stationId'
        - $ref: '#/components/parameters/chargerId'
        - $ref: '#/components/parameters/connectorId'
      responses:
        '200':
          description: Connector found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            Station, charger, or connector not found, or an ID format is
            invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    stationId:
      name: stationId
      in: path
      required: true
      description: >-
        Station public identifier. Exactly 8 alphanumeric characters
        (a-zA-Z0-9).
      schema:
        type: string
    chargerId:
      name: chargerId
      in: path
      required: true
      description: >-
        Charger public identifier. Exactly 8 alphanumeric characters
        (a-zA-Z0-9).
      schema:
        type: string
    connectorId:
      name: connectorId
      in: path
      required: true
      description: >-
        1-based positive connector integer ID within the charger. The path
        segment is parsed as a base-10 integer; non-integer values and values
        below 1 return 404.
      schema:
        type: string
  schemas:
    ConnectorResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Connector'
    ErrorResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    Connector:
      type: object
      required:
        - id
        - chargerId
        - status
      properties:
        id:
          type: integer
          minimum: 1
        chargerId:
          type: string
          minLength: 1
        status:
          type: string
          enum:
            - Available
            - Preparing
            - Charging
            - Occupied
            - SuspendedEVSE
            - SuspendedEV
            - Finishing
            - Reserved
            - Unavailable
            - Faulted
        type:
          type: string
          enum:
            - T1
            - T2
            - CCS
            - CCS2
            - C
            - D
            - BHARAT_DC_001
            - BHARAT_AC_001_THREE
            - BHARAT_AC_001_SINGLE
            - U
        currentType:
          type: string
          enum:
            - AC
            - DC
        powerKw:
          type: number
        voltage:
          type: number
        amperage:
          type: number
        tariffId:
          type: string
          minLength: 1
          description: >-
            Effective tariff identifier for this connector. Omitted when no
            tariff applies.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key issued during onboarding. Every request must supply a valid
        x-api-key header.

````

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