Skip to main content

List Vehicle Assignments

Returns a list of vehicle assignments.

Query Parameters
  • start_cursor string

    The start cursor for Keyset pagination.

  • per_page integer

    Possible values: >= 2 and <= 100

    Default value: 50

    The number of records per page to return

  • filter object

    The fields, operations, and values to filter the records by.

    • contact_id object
    • eq string required
    • vehicle_id object
    • eq string required
    • ended_at object
      oneOf
    • lt string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • started_at string

      Possible values: [asc, desc]

    • ended_at string

      Possible values: [asc, desc]

    • created_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

    • id string

      Possible values: [asc, desc]

      Default value: desc

Responses

OK

Schema

  • start_cursor string

    The current start cursor of the records returned.

  • next_cursor string

    The next cursor to retrieve the next page of records.

  • per_page integer

    The maxumum number of records returned.

  • estimated_remaining_count integer

    The number of remaining records including the returned records, up to a maximum of 500.

  • filtered_by object[]

    The filters applied to the returned record set.

    anyOf
  • contact_id object
  • eq string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • started_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • vehicle_id integer

    The id of the vehicle associated with this Vehicle Assignment.

  • contact_id integer

    The id of the contact associated with this Vehicle Assignment.

  • started_at date-time

    The date and time of this Vehicle Assignment. Dates in the future are accepted. We recommend using ISO-8601 formatted dates to avoid ambiguity.

  • ended_at date-time

    The date and time of this Vehicle Assignment ending. We recommend using ISO-8601 formatted dates to avoid ambiguity.

  • current boolean

    Default value: false

    Whether this Vehicle Assignment is current/active.

  • future boolean

    Default value: false

    Whether this Vehicle Assignment is set to take place in the future.

  • starting_meter_entry_value number

    The meter value at the start of this Vehicle Assignment.

  • ending_meter_entry_value number

    The meter value at the end of this Vehicle Assignment.

  • comments_count integer

    The number of comments on this Vehicle Assignment.

  • attachment_permissions object
  • read_photos boolean

    Indicates whether the user has read permission for photos.

  • manage_photos boolean

    Indicates whether the user has permission to manage (eg. upload, delete) photos.

  • read_documents boolean

    Indicates whether the user has read permission for documents.

  • manage_documents boolean

    Indicates whether the user has permission to manage (eg. upload, delete) documents.

  • contact object

    A Contact

  • id integer
  • email string

    The Contact's email address.

  • name string

    The Contact's full name.

  • group_id integer

    If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

  • default_image_url string

    The URL of the Contact's default image/profile photo, if any.

  • vehicle object

    A Vehicle

  • id integer
  • name string

    This vehicle's name.

  • color string

    The color of this Vehicle.

  • license_plate string

    The license plate number of this Vehicle.

  • vin string

    The Vehicle Identification Number of this Vehicle.

  • year string

    This Vehicle's model year.

  • make string

    The name of this Vehicle's manufacturer.

  • model string

    The name of the model of this Vehicle.

  • trim string

    The trim level of this Vehicle.

  • registration_expiration_month integer

    Possible values: <= 12

    The month in which this Vehicle's registration expires.

  • registration_state string

    The state, province, or territory in which this Vehicle is registered.

  • default_image_url_small string

    The URL of a small-sized version of the default image for this Vehicle.

Loading...