Get a list of Vehicles.

1min
GET
https://{domain}/app/api/v2/vehicles
Query Parameters
size
integer
page
integer
select_
string[]
query
Query
sortBy
SortBy
sortKey
SortKey
additionalInfo
AdditionalInfo
Responses
200
Get Vehicles Response
object
error
Error
data
object
request
Request
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/app/api/v2/vehicles' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/app/api/v2/vehicles' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
default
// Get Vehicles Response 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "meta": {
      "totalElements": 0
    },
    "vehicles": [
      {
        "id": "vehicles:<uuid>",
        "state": "onboarding:onboarding",
        "participantType": "vehicles",
        "name": "AmazonIndia1",
        "owner": "tenants:<uuid>",
        "uniqueCode": "external-ref-id",
        "category": "",
        "subCategory": "",
        "templateId": "template:<uuid>",
        "properties": {},
        "createdAt": 1257894000,
        "createdBy": {
          "id": 7,
          "name": "shivam"
        },
        "updatedAt": 1257894000,
        "updatedBy": {
          "id": 7,
          "name": "shivam"
        }
      }
    ]
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
// Get Vehicles Response 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "meta": {
      "totalElements": 0
    },
    "vehicles": [
      {
        "id": "vehicles:<uuid>",
        "state": "onboarding:onboarding",
        "participantType": "vehicles",
        "name": "AmazonIndia1",
        "owner": "tenants:<uuid>",
        "uniqueCode": "external-ref-id",
        "category": "",
        "subCategory": "",
        "templateId": "template:<uuid>",
        "properties": {},
        "createdAt": 1257894000,
        "createdBy": {
          "id": 7,
          "name": "shivam"
        },
        "updatedAt": 1257894000,
        "updatedBy": {
          "id": 7,
          "name": "shivam"
        }
      }
    ]
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
﻿
﻿
Updated 01 Dec 2023
Did this page help you?
Create a Vehicle.
Get a Vehicle by id or external ref