List Vehicle Assignments

List the Vehicle's assignments

Path Parameters

• id string required

  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
• 401
• 500

---

OK

Response Headers

• X-PaginationLimit string

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

• X-Pagination-Current-Page string

  The current page. Defaults to 1.

• X-Pagination-Total-Pages string

  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 string

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

application/json

• Schema
• Example (from schema)

---

Schema

array

id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
started_at date-time
The date and time at which this Assignment began.
ended_at date-time
The date and time at which this Assignment ended
deleted_at date-time
The date and time at which this Assignment was deleted.
active boolean
Default value: false
Whether or not this Assignment is active.
vehicle_id integer
Possible values: >= 1
contact_id integer
Possible values: >= 1
custom_fields object
*Full details on working with Custom Fields here.
contact object
id integer
Possible values: >= 1
default_image string
full_name string

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

Request could not be authenticated

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  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.

• detail string

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

• instance string

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

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

Something unexpected happened

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  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.

• detail string

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

• instance string

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

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

Loading...