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

# Get connection

> Get a specific user/vehicle connection for the application



## OpenAPI

````yaml /specs/vehicle.yml get /connections/{connectionId}
openapi: 3.0.3
info:
  title: Smartcar Vehicle API
  version: 3.0.0
  description: API for vehicle data (signals) and operations (commands).
servers:
  - url: https://vehicle.api.smartcar.com/v3
security: []
tags:
  - name: Charging
    description: Commands for controlling vehicle charging behavior.
  - name: Security
    description: Commands for controlling vehicle door locks.
  - name: Navigation
    description: Commands for setting destinations in the vehicle navigation system.
  - name: Command Executions
    description: Retrieve the recorded result of a previously issued vehicle command.
  - name: Charge Schedules
    description: Create, retrieve, and delete recurring charge schedules on a vehicle.
  - name: Schedule Executions
    description: >-
      Retrieve the recorded result of a previously issued schedule create or
      delete request.
paths:
  /connections/{connectionId}:
    parameters:
      - name: connectionId
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier for the connection
    get:
      summary: Get connection
      description: Get a specific user/vehicle connection for the application
      operationId: getConnection
      responses:
        '200':
          description: Get a specific user/vehicle connection for the application
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionDataResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    ConnectionDataResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ConnectionResponse'
      example:
        data:
          id: 32c4139a-e4aa-4c6c-b357-3ae9022dbf1b
          type: connection
          attributes:
            permissions:
              - read_vehicle_info
              - read_odometer
            vehicle:
              make: Tesla
              model: Model S
              year: 2020
              mode: live
              powertrainType: BEV
          relationships:
            vehicle:
              data:
                id: a6a425d6-c661-4b21-af7a-d6b75f80f3b0
                type: vehicle
              links:
                related: >-
                  https://api.example.com/vehicles/a6a425d6-c661-4b21-af7a-d6b75f80f3b0
            user:
              data:
                id: 1e258add-fb21-4293-b9ab-cf8a61f7a880
                type: user
          meta:
            createdAt: '2024-01-01T00:00:00Z'
            updatedAt: '2024-01-02T00:00:00Z'
          links:
            self: >-
              https://api.example.com/connections/32c4139a-e4aa-4c6c-b357-3ae9022dbf1b
    ConnectionResponse:
      type: object
      properties:
        id:
          type: string
          description: |
            The unique identifier for the connection.
        type:
          type: string
          enum:
            - connection
          default: connection
        attributes:
          $ref: '#/components/schemas/ConnectionAttributes'
        relationships:
          type: object
          properties:
            vehicle:
              $ref: '#/components/schemas/VehicleRelationship'
            user:
              $ref: '#/components/schemas/UserRelationship'
        meta:
          $ref: '#/components/schemas/MetaAttributes'
        links:
          type: object
          allOf:
            - $ref: '#/components/schemas/SelfLink'
    ErrorResponse:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          minItems: 1
          items:
            type: object
            required:
              - status
              - type
              - code
              - title
              - detail
            properties:
              status:
                type: string
              type:
                type: string
                enum:
                  - AUTHENTICATION
                  - BILLING
                  - COMPATIBILITY
                  - CONNECTED_SERVICES_ACCOUNT
                  - RATE_LIMIT
                  - RESOURCE_NOT_FOUND
                  - SERVER
                  - UPSTREAM
                  - VALIDATION
                  - VEHICLE_STATE
              code:
                type: string
              title:
                type: string
              detail:
                type: string
              resolution:
                type: object
                description: >-
                  Optional field providing guidance on how to resolve the error,
                  if applicable. The structure of this object can vary based on
                  the error type and is intended to provide actionable
                  information to clients.
                properties:
                  type:
                    type: string
                    description: >-
                      The type of resolution recommended (e.g., "RETRY_LATER",
                      "CONTACT_SUPPORT", etc.)
              suggestedUserMessage:
                type: string
                description: >-
                  Optional field providing a user-friendly message that can be
                  displayed to end-users, if applicable. This message is
                  intended to be easily understandable and actionable for users
                  who encounter the error.
              links:
                type: object
                properties:
                  about:
                    type: string
                    format: uri
              meta:
                type: object
                properties:
                  debug:
                    type: object
                    description: >-
                      Debug information for internal use, not intended for
                      clients
                    properties:
                      applicationId:
                        type: string
                        description: The unique identifier for the application
                      requestId:
                        type: string
                        description: The unique identifier for the request
                      origin:
                        type: string
                        description: The origin of the error
                    example:
                      applicationId: app_123abc
                      requestId: req_456def
                      origin: internal.com/path
    ConnectionAttributes:
      type: object
      properties:
        permissions:
          type: array
          description: |
            The permissions granted to the connection.
          items:
            type: string
        vehicle:
          type: object
          properties:
            make:
              type: string
            model:
              type: string
            year:
              type: integer
            powertrainType:
              type: string
            mode:
              $ref: '#/components/schemas/VehicleMode'
      example:
        permissions:
          - read_vehicle_info
          - read_odometer
        vehicle:
          make: Tesla
          model: Model S
          year: 2020
          mode: live
          powertrainType: BEV
    VehicleRelationship:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: |
                The unique identifier for the vehicle.
            type:
              type: string
              enum:
                - vehicle
        links:
          $ref: '#/components/schemas/RelatedLink'
    UserRelationship:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: |
                The unique identifier for the user.
            type:
              type: string
              default: user
        links:
          $ref: '#/components/schemas/RelatedLink'
    MetaAttributes:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: |
            ISO 8601 UTC date string when the resource was created
        updatedAt:
          type: string
          format: date-time
          description: |
            ISO 8601 UTC date string when the resource was last updated
      example:
        createdAt: '2023-10-01T20:00:00Z'
        updatedAt: '2023-10-01T20:00:00Z'
        lastUsedAt: null
    SelfLink:
      type: object
      properties:
        self:
          type: string
          description: |
            The URL to access the current resource.
    VehicleMode:
      type: string
      description: The mode of the vehicle
      enum:
        - live
        - simulated
      example: live
    RelatedLink:
      type: object
      properties:
        related:
          type: string
          description: |
            The URL to access the related resource.
  responses:
    BadRequest:
      description: 400 Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - status: '400'
                type: VALIDATION
                code: BAD_REQUEST
                title: Bad Request
                detail: >-
                  The request could not be understood by the server due to
                  malformed syntax.
                links:
                  about: >-
                    https://smartcar.com/docs/errors/api-errors/v3/validation-errors
    Unauthorized:
      description: 401 Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - status: '401'
                type: AUTHENTICATION
                code: UNAUTHORIZED
                title: Unauthorized
                detail: The Authorization token is missing or invalid.
                links:
                  about: >-
                    https://smartcar.com/docs/errors/api-errors/v3/authentication-errors#authentication
    Forbidden:
      description: 403 Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - status: '403'
                type: AUTHENTICATION
                code: FORBIDDEN
                title: Forbidden
                detail: You do not have permission to access this resource.
                links:
                  about: >-
                    https://smartcar.com/docs/errors/api-errors/v3/authentication-errors
    NotFound:
      description: 404 Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - status: '404'
                type: RESOURCE_NOT_FOUND
                code: NOT_FOUND
                title: Not Found
                detail: The requested resource could not be found.
                links:
                  about: >-
                    https://smartcar.com/docs/errors/api-errors/v3/resource-not-found-errors
    InternalError:
      description: 500 Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - status: '500'
                type: SERVER
                code: INTERNAL
                title: Internal Server Error
                detail: An unexpected error occurred on the server.
                links:
                  about: https://smartcar.com/docs/errors/api-errors/v3/server-errors
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or opaque
      description: |
        The Authorization header must be provided with a valid bearer token.
        Example: `Authorization: Bearer {token}`

````