---
title: "Vehicle's Alarm"
method: GET
path: "/fleets/{fid}/vehicles/{vid}/alarms/{aid}"
tags: ["Vehicles"]
---

# Vehicle's Alarm

`GET /fleets/{fid}/vehicles/{vid}/alarms/{aid}`

## Request

- Base URL: `https://api-cert.groupe-psa.com/connectedcar/v3`
- URL: `https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/vehicles/{vid}/alarms/{aid}`
- Auth: HTTP basic and API key in query parameter `client_id`
- TypeScript: <https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/docs/fleets/:fid/vehicles/:vid/alarms/:aid/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns information about a specific alarm for a vehicle.

## Path parameters

- `fid` string, required
- `vid` string, required
- `aid` string, required

## Response `200`

Alarm response

- AlarmDetails: Describes the vehicle alarm status or trigger. Only one is present.
  - `id` string, required
  - `trigger` AlarmTrigger: Describe a vehicle alarm trigger.
    - `createdAt` string, date-time, required: Date when the resource has been created.
    - `type` 'NoBreakIn' | 'FrontRightDoorBreakIn' | 'FrontLeftDoorBreakIn' | 'RearRightFrontDoorBreakIn' | 'RearLeftFrontDoorBreakIn' | 'HoodDoorBreakIn' | 'TrunkDoorBreakIn' | 'BackliteDoorBreakIn' | 'RoofBreakIn' | 'VolumetricBreakIn' | 'VehicleLifting' | 'ElectricalsystemBreakIn' | 'KeyLearning' | 'UnauthenticatedStartup', required: Define the vehicle break-in type.
    - `position` object: The position (last vehicle known one) where the alarm triggered.
      - `type` 'Feature', required
      - `geometry` Point, required: This object expresses a GeoJSON Point as specified by [rfc7946](https://tools.ietf.org/html/rfc7946#section-3.1.2).
        - `coordinates` number[], required: This is a simple 2 (or more) numbers vector used to define Geometry Point objects.
        - `type` 'Point', required
      - `properties` object, required
        - `createdAt` string, date-time, required: Date when the resource has been created.
        - `vin` string: Identifier of a vehicle. **Set when retrieving resource in batch mode**.
        - `heading` integer: Course angle expressed in degree.
        - `signalQuality` integer
        - `type` 'Estimated' | 'Acquire'
        - `fixStatus` '2D' | '3D': Fix status information is only returned when position type is set to Acquire. Horizontal & altitude position can be determined in 3D fix status mode where it is only horizontal position in 2D mode.
    - `startAt` string, date-time, required: Time when the alarm triggering started.
  - `status` AlarmStatus: Describe a vehicle alarm status.
    - `createdAt` string, date-time, required: Date when the resource has been created.
    - `activation` 'Inactive' | 'Active', required: Define whether the vehicle alarm is active or not.

## Other responses

- `default` (unresolved $ref)

---

[API](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api.md) - [All operations](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/llms.txt) - [OpenAPI document](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/revisions/023ff3e3fe51?raw)