Skip to main content

List Vehicle Status Changes

Returns a list of Vehicle Status Changes

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.

    • vehicle_id object
    • eq string required
    • from_vehicle_status_id object
    • eq string required
    • to_vehicle_status_id object
    • eq 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.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • updated_at string

      Possible values: [asc, desc]

    • vehicle_id string

      Possible values: [asc, 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
  • vehicle_id object
  • eq string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • id string

    Possible values: [asc, desc]

  • records object[]
  • account_id integer

    The ID of the Account that owns the Vehicle Status Change.

  • id integer

    The ID of the Vehicle Status Change.

  • vehicle_id integer

    The ID of the Vehicle that the Vehicle Status Change is for.

  • from_vehicle_status_id integer

    The ID of the Vehicle Status that the Vehicle transitioned from.

  • to_vehicle_status_id integer

    The ID of the Vehicle Status that the Vehicle transitioned to.

  • user_id integer

    The ID of the User that created the Vehicle Status Change.

  • effective_until date-time

    The date and time that the Vehicle Status Change is effective until.

  • created_at date-time

    The date and time that the Vehicle Status Change was created.

  • updated_at date-time

    The date and time that the Vehicle Status Change was last updated.

  • 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...