List Vehicle Assignments

GET 
https://secure.fleetio.com/api/v1/vehicles/:id/vehicle_assignments

List the Vehicle's assignments

Request

Path Parameters

id stringrequired

The Fleetio ID of the relevant Vehicle.

You may also look up Vehicles by their VIN, license plate, or other external ID. See the guide on External Vehicle Ids for information on how to set this up.

Responses

200

OK

Response Headers

X-PaginationLimit

The per page limit. Currently set to 100 but subject to change at any time.

X-Pagination-Current-Page

The current page. Defaults to 1.

X-Pagination-Total-Pages

The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

X-Pagination-Total-Count

The total number of records in the result set (across all pages).

application/json

Schema

Schema

Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
started_atdate-timenullablerequired
The date and time at which this Assignment began.
ended_atdate-timenullablerequired
The date and time at which this Assignment ended
deleted_atdate-timenullable
The date and time at which this Assignment was deleted.
activeboolean
Whether or not this Assignment is active.
Default value: false
vehicle_idId (integer)required
Possible values: >= 1
contact_idId (integer)required
Possible values: >= 1
custom_fieldsobjectnullablerequired
*Full details on working with Custom Fields here.
contact object
idId (integer)
Possible values: >= 1
default_imagestringnullable
full_namestring
]

Example (auto)

[
  {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "started_at": "2024-07-29T15:51:28.071Z",
    "ended_at": "2024-07-29T15:51:28.071Z",
    "deleted_at": "2024-07-29T15:51:28.071Z",
    "active": false,
    "vehicle_id": 0,
    "contact_id": 0,
    "custom_fields": {},
    "contact": {
      "id": 0,
      "default_image": "string",
      "full_name": "string"
    }
  }
]

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!