> ## 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. # List signals > Get list of signals for a vehicle. ## OpenAPI ````yaml /specs/vehicle.yml get /vehicles/{vehicleId}/signals 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: /vehicles/{vehicleId}/signals: get: summary: List signals description: Get list of signals for a vehicle. operationId: getVehicleSignals parameters: - in: path name: vehicleId description: The unique identifier for the vehicle. schema: type: string example: v_123abc456def required: true - in: header name: sc-user-id required: true description: > The identifier of the vehicle user on whose behalf the command is being executed. Vehicle commands require both the `vehicleId` (path) and `sc-user-id` (header) to identify the specific vehicle and the user who has granted permission to act on it. The bearer token is a machine-to-machine token and does not carry per-user context, so this header must be provided explicitly for every command request. schema: type: string example: user_789xyz responses: '200': description: List of signals for the vehicle content: application/json: schema: $ref: '#/components/schemas/SignalsResponse' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound1' '500': $ref: '#/components/responses/InternalError' security: - bearerAuth: [] components: schemas: SignalsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SignalResource' meta: type: object allOf: - $ref: '#/components/schemas/PagingMetaData' links: type: object allOf: - $ref: '#/components/schemas/SelfLink' - $ref: '#/components/schemas/PagingLinks1' included: type: object properties: vehicle: $ref: '#/components/schemas/VehicleResource' SignalResource: type: object properties: id: type: string description: | The unique human readable identifier for the signal. type: type: string enum: - signal attributes: $ref: '#/components/schemas/SignalAttributes' meta: type: object allOf: - $ref: '#/components/schemas/DateMetaData' links: type: object allOf: - $ref: '#/components/schemas/SelfLink' PagingMetaData: type: object properties: pageNumber: type: integer description: | The current page number of the paginated results. pageSize: type: integer description: | The number of items returned per page. totalCount: type: integer description: | The total number of items available across all pages. example: pageNumber: 1 pageSize: 10 totalCount: 5 SelfLink: type: object properties: self: type: string description: | The URL to access the current resource. PagingLinks1: type: object properties: self: type: string description: | The URL to access the current page of results. first: type: string description: | The URL to access the first page of results. prev: type: string description: | The URL to access the previous page of results. next: type: string description: | The URL to access the next page of results. last: type: string description: | The URL to access the last page of results. example: self: /vehicles/vehicle123/signals?page=1&pageSize=10 first: /vehicles/vehicle123/signals?page=1&pageSize=10 prev: null next: /vehicles/vehicle123/signals?page=2&pageSize=10 last: /vehicles/vehicle123/signals?page=5&pageSize=10 VehicleResource: type: object properties: id: type: string description: | The unique identifier for the vehicle type: type: string enum: - vehicle attributes: $ref: '#/components/schemas/VehicleAttributes' 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 SignalAttributes: type: object properties: code: type: string description: | The unique identifier for the data point. name: type: string description: | The name of the datapoint, which is a human-readable identifier. group: type: string description: | The group to which the data point belongs, used for categorization. status: $ref: '#/components/schemas/SignalStatus' body: type: object description: > The body can contain various properties depending on the signal type. For more information about specific signal types and their properties, refer to [Vehicle Signals](https://smartcar.com/docs/api-reference/signals/schema) example: code: charge-voltage name: Voltage group: Charge status: value: SUCCESS body: unit: volts value: 85 DateMetaData: type: object properties: retrievedAt: type: string format: date-time description: | ISO 8601 UTC date string of the last retrieval of this data point oemUpdatedAt: type: string format: date-time description: > ISO 8601 UTC date string of the last update of this data point by the OEM ingestedAt: type: string format: date-time description: | ISO 8601 UTC date string of when the signal was sent and processed example: retrievedAt: '2023-10-01T20:00:00Z' oemUpdatedAt: '2023-10-01T19:59:59Z' ingestedAt: '2023-10-01T20:01:00Z' VehicleAttributes: type: object properties: make: type: string model: type: string year: type: integer powertrainType: type: string mode: $ref: '#/components/schemas/VehicleMode' SignalStatus: type: object properties: value: type: string description: > The state of the signal, indicating whether it is active, inactive, or in an error state. enum: - SUCCESS - ERROR - UNAVAILABLE error: $ref: '#/components/schemas/SignalError' example: value: ERROR error: type: SignalError code: SIGNAL_NOT_FOUND description: The requested signal does not exist. resolution: type: REAUTHENTICATE VehicleMode: type: string description: The mode of the vehicle enum: - live - simulated example: live SignalError: type: object properties: type: type: string description: | The type of error that occurred, indicating the nature of the issue. code: type: string description: > A code representing the specific error, used for error handling and debugging. title: type: string description: | A brief, human-readable summary of the error type. detail: type: string description: | A human-readable message describing the error. resolution: type: object properties: type: type: string description: Describes types of actions to be take to resolve an error state example: type: CONNECTED_SERVICES_ACCOUNT code: AUTHENTICATION_FAILED message: The authentication for the connected services account failed. resolution: type: REAUTHENTICATE responses: BadRequest1: 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 NotFound1: description: 404 Not Found content: application/json: schema: 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 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}` ````