Docs
Vehicles
Associations Users

Associations Users

Create Vehicles Associations Users

POST /v2/vehicles/associations/users

Payload

{
  "body": {
    "data": [
      {
        "vehicle_id": "ABC1234567890DEF",
        "user_id": "GHI9876543210JKL"
      },
      {
        "vehicle_id": "MNO4567890123PQR",
        "user_id": "STU2109876543VWX"
      }
    ]
  }
}
FieldDescriptionRequired
dataObjecttrue
vehicle_idString named after the ID of the vehicle associated with the user. Must be alphanumeric and 15 characters long.true
user_idString named after the ID of the user associated with the vehicle. Must be alphanumeric and 15 characters long.true

Responses

StatusMeaningDescription
200OKDefault Response
400Bad RequestOne of 'Bad Request' or 'Vehicle And User Are in Different Enterprises'

This operation does not require authentication

Delete Vehicles Associations Users

DELETE /v2/vehicles/associations/users

Payload

{
  "body": {
    "data": [
      {
        "type": "user_permission",
        "id": "ABC1234567890DEF"
      },
      {
        "type": "user_permission",
        "id": "GHI9876543210JKL"
      }
    ]
  }
}
FieldDescriptionRequired
dataObject
typeString named after the type of permission, which must be equal to 'user_permission'.true
idString named after the ID of the permission. Must be alphanumeric and 15 characters long.true

Responses

StatusMeaningDescription
200OKDefault Response
400Bad RequestBad Request
404Not FoundAssociation Not Found

This operation does not require authentication

List Vehicles Associations Users

GET /v2/vehicles/{vehicle_id}/associations/users

ParameterDescription
attributesSpecifies which attributes to retrieve. Can include values like 'serial', 'number', 'carrier', 'service_provider', and 'batch'. If null, retrieves all information.
includesSpecifies related entities to include in the query. Contains arrays for 'device' and 'enterprise', each with its own set of possible values, such as 'name', 'imei', 'code' for the 'device' array, and 'name', 'cnpj' for the 'enterprise' array.
filtersSpecifies filters for various fields such as 'chips.serial', 'chips.number', 'chips.carrier', 'chips.service_provider', 'chips.batch', 'device.name', 'device.imei', 'device.code', 'enterprise.name', 'enterprise.cnpj'. Each filter field supports conditions like 'eq', 'neq', 'ilk', 'ew', 'sw'.
searchSpecifies the search query with a maximum length of 100 characters.
limitSpecifies the maximum number of results to return. Must be a number between 1 and 100.
pageSpecifies the page number for paginated results. Must be a number greater than or equal to 0.
countIndicates whether to include the total count of results in the response.
sortSpecifies sorting criteria for 'number' and 'serial' fields. Values can be -1 (descending order) or 1 (ascending order).

Responses

StatusMeaningDescription
200OKDefault Response
400Bad RequestBad Request

This operation does not require authentication