Vehicles
A vehicle is a car, truck, or other vehicle known to your account, identified by vehicleId. The license plate is the identifier a gate or fleet system already has. Vehicles are referenced from vehicle check-ins.
Identity
Section titled “Identity”Vehicles are addressed by vehicleId:
/profiles/vehicles/{vehicleId}vehicleId is an integer returned when the vehicle is created. licensePlate is required on create and can be used to search vehicles and vehicle check-ins.
Operations
Section titled “Operations”Every vehicle endpoint lives under Vehicles in the API Reference.
Creating and updating
Section titled “Creating and updating”Creates a vehicle and returns VehicleResponse with the new vehicleId. Send an Idempotency-Key on create — see Idempotency.
Applies a partial update: only fields you send are changed.
Removes the vehicle and returns 204 No Content.
Labels
Section titled “Labels”Vehicle labels are separate from person labels. Create them under /labels/vehicles, then assign them with PUT /profiles/vehicles/{vehicleId}/labels.
Check-ins
Section titled “Check-ins”Vehicle check-ins use the same verbs as person check-ins, under /checkins/vehicles. Create accepts vehicleId or licensePlate. Checkout is by check-in id. Search by licensePlate to find the open visit for a registered vehicle.
Webhook deliveries for vehicle visits use VEHICLE_CHECKIN_ENTERED, VEHICLE_CHECKIN_EXITED, VEHICLE_CHECKIN_PENDING, and VEHICLE_CHECKIN_STOPPED. See Webhooks.