Skip to main content

List Inspection Schedules

Returns a list of Inspection Schedules.

Query Parameters
  • include_occurrences integer

    Includes upcoming_occurrences for each schedule, if any.

Responses

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

Schema

array
  • id integer

    Possible values: >= 1

  • active boolean

    Whether this Inspection Schedule is active.

  • vehicle_id integer

    Possible values: >= 1

  • inspection_form_id integer

    Possible values: >= 1

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • recurring_rule_description string

    This describes the recurrence behavior of the Inspection Schedule.

  • overdue boolean

    Whether this Inspection Schedule is overdue.

  • due_soon boolean

    Whether this Inspection Schedule is due soon.

  • next_due string

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

  • next_due_relative_time string

    The relative time until this Inspection Schedule is next due. If the Inspection Schedule is overdue, it will describe how long ago it was due. This attribute will only appear in responses if there is a next due date, or overdue.

  • recurring_schedule_start_at string

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

  • upcoming_occurrences string[]
Loading...