Consultar todos los vehículos

[ GET ]

Devuelve la lista completa de vehículos registrados para tu empresa. Este endpoint no genera cambios sobre los datos.

https://sync.airbagtech.io/vehicle

Parámetros de consulta

Todos son opcionales y se envían en la URL (query string).

Nombre	Tipo	Descripción
limit	Number	Número máximo de vehículos a devolver.
sort	String	Campo por el que se ordena: brand, color, created, driverId, fuel, height, insuranceBrand, insuranceExpiration, insuranceNumber, model, uid, vehicleType, width o length. Si envías startDate/endDate, sólo se permite created.
direction	String	asc o desc.
startDate	String	Junto con endDate, filtra por fecha de creación del vehículo: se incluyen los creados después de startDate y hasta endDate (inclusive). Formato ISO 8601.
endDate	String	Fin del rango de fecha de creación. Debe ser posterior a startDate.

Headers

Authorization
apikey {{API_KEY}}

Ejemplo

curl --location 'https://sync.airbagtech.io/vehicle?limit=20&sort=created&direction=desc' \
  --header 'Authorization: apikey {{API_KEY}}'

Respuestas

✅ Respuesta exitosa (200 OK)

Devuelve el número total de vehículos registrados (length) y un arreglo vehicles con la ficha de cada uno. La ficha combina los datos cargados al momento de crear o editar el vehículo; los campos que el vehículo no tiene no aparecen en su ficha.

{
  "status": true,
  "length": 12,
  "vehicles": [
    {
      "niv": "3VWFE21C04M000111",
      "brand": "toyota",
      "fuel": "f-gas",
      "uid": "UN-0012",
      "vehicleType": "s-vehicle",
      "model": "Corolla",
      "plate": "ABC-123",
      "airbagId": "a1b2c3d4_e5f6_4708_9102_3456789abcde",
      "company": "Transportes Ejemplo"
    },
    {
      "niv": "",
      "brand": "mazda",
      "fuel": "f-gas",
      "uid": "Mazda Rojo",
      "vehicleType": "s-vehicle",
      "model": "CX-30",
      "plate": "XYZ-987",
      "airbagId": "Qr3StUv4WxYz5aBcDeFg",
      "company": "Transportes Ejemplo"
    },
    {
      "niv": "",
      "brand": "byd",
      "fuel": "f-electric",
      "uid": "BYD-NORTE-01",
      "vehicleType": "s-vehicle",
      "model": "Song",
      "plate": "",
      "airbagId": "Lm8NpQrSt2UvWxYzAbCd",
      "company": "Transportes Ejemplo"
    },
    {
      "internalCompanyId": "VAN-SUR-04",
      "niv": "1HD2WMM12NB600041",
      "brand": "volkswagen",
      "fuel": "f-diesel",
      "uid": "CARGO-04",
      "vehicleType": "van",
      "model": "Crafter",
      "plate": "MBP-4410",
      "airbagId": "9e0f1a2b_3c4d_4506_8a9b_c0d1e2f34567",
      "company": "Transportes Ejemplo"
    },
    {
      "niv": "",
      "brand": "honda",
      "fuel": "f-gas",
      "uid": "MOTO-06",
      "vehicleType": "motorcycle",
      "model": "CB190R",
      "plate": "MT-0612",
      "airbagId": "Bc7DeFgH8iJkLmNoPqRs",
      "company": "Transportes Ejemplo"
    },
    {
      "niv": "",
      "brand": "kenworth",
      "fuel": "f-diesel",
      "uid": "T-ENTREGA-2",
      "vehicleType": "T2-S1",
      "model": "T680",
      "plate": "TR-8821",
      "airbagId": "7f8091a2_b3c4_4d56_97e8_f9011a2b3c4d",
      "company": "Transportes Ejemplo"
    },
    {
      "niv": "",
      "brand": "",
      "fuel": "",
      "uid": "",
      "vehicleType": "",
      "model": "",
      "plate": "VEH-0007",
      "airbagId": "45cd67ef_890a_4b12_c3d4_5e6f78901234",
      "company": "Transportes Ejemplo"
    }
  ]
}

nota

En una respuesta real, vehicles contiene length elementos. El ejemplo anterior muestra sólo algunos para ilustrar los distintos escenarios: vehículos con todos los campos, con campos vacíos (""), con internalCompanyId, y con distintos valores de vehicleType y fuel.

Descripción de campos de respuesta

Campo	Tipo	Descripción
status	Boolean	Indica si la operación fue exitosa.
length	Number	Número total de vehículos devueltos en vehicles.
vehicles	Array<Object>	Lista de vehículos registrados en la empresa. Ver tabla abajo.

Campos dentro de cada elemento de vehicles

Campo	Tipo	Descripción
airbagId	String	Identificador interno único del vehículo en la plataforma Airbag. Útil para operaciones internas y referencias cruzadas.
uid	String	Nombre a mostrar del vehículo (unit ID, número económico, etc.). Al crear o editar se envía como name.
internalCompanyId	String	ID del vehículo definido por tu empresa: el id enviado al crearlo. Es el ID que utilizas en tus sistemas. Puede faltar en vehículos registrados sin ese ID.
company	String	Nombre de la organización propietaria del vehículo.
brand	String	Marca del vehículo (por ejemplo toyota, mazda, volkswagen). Consulta los valores soportados en Vehículos › Tipos de vehículos.
model	String	Modelo del vehículo (por ejemplo Corolla, CX-30). Puede estar vacío si no se cargó.
plate	String	Placa o matrícula del vehículo. Puede estar vacía si no se cargó.
niv	String	Número de Identificación Vehicular (VIN). Puede estar vacío si no se cargó.
fuel	String	Tipo de combustible. Valores soportados: f-gas, f-diesel, f-electric. Consulta la tabla en Vehículos › Tipos de combustible. Puede estar vacío si no se cargó.
vehicleType	String	Categoría del vehículo. Valores comunes: s-vehicle (vehículo estándar), van, motorcycle, así como las categorías de carga (T2-S1, B2, B3, C2, etc.). Consulta la lista completa en Vehículos › Tipos de vehículos. Puede estar vacío si no se cargó.

⚠️ Sin resultados (404 Not Found)

Se devuelve cuando ningún vehículo coincide con los filtros. status es true porque la consulta se procesó.

{
  "status": true,
  "message": "No vehicles found with given parameters",
  "length": 0,
  "vehicles": []
}

❌ Parámetros inválidos (400 Bad Request)

Si hay varios errores, los mensajes llegan separados por comas.

{
  "status": false,
  "message": "Sort field not in the list"
}

❌ Respuesta con error (401 Unauthorized)

Se devuelve cuando la API key no existe o está inactiva. Si falta el encabezado Authorization la respuesta es 400; ver Autenticación › Errores de autenticación.

{
  "status": false,
  "error": "You are not authorized to perform this action",
  "errorId": "-1"
}