Skip to main content

List Inspection Schedules

Returns a list of Inspection Schedules.

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
    • inspection_form_id object
    • eq string required
    • active object
    • eq string required
    • inspection_schedule_status object
    • eq string required

      Possible values: [ok, overdue, due_soon]

    • last_inspected_at object
      oneOf
    • lt string required
    • last_sent_at object
      oneOf
    • lt string required
    • next_due_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.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • last_inspected_at string

      Possible values: [asc, desc]

    • last_sent_at string

      Possible values: [asc, desc]

    • next_due_at string

      Possible values: [asc, desc]

    • created_at string

      Possible values: [asc, desc]

    • updated_at 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
  • last_inspected_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • active boolean

    Whether this Inspection Schedule is active.

  • vehicle_id integer
  • inspection_form_id integer

    The Id of the InspectionForm associated with this Inspection Schedule.

  • last_submission_id integer

    The Id of the most recent SubmittedInspectionForm for this Inspection Schedule.

  • updated_at date-time
  • created_at date-time
  • recurring_rule_description string

    This describes the recurrence behavior of the Inspection Schedule.

  • recurring_schedule_start_at date-time

    The date and time at which this Inspection Schedule's recurrence behavior began. This attribute will only appear in responses if the Inspection Schedule is recurring.

  • next_due_at date-time

    The date and time at which this Inspection Schedule is next due. This attribute will only appear in responses if there is a next due date.

  • last_sent_at date-time

    The date and time at which this Inspection Schedule was last sent.

  • last_inspected_at date-time

    The date and time of the last SubmittedInspectionForm.

  • inspection_schedule_status string

    Possible values: [due_soon, overdue, ok]

    The status of this Inspection Schedule.

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