Skip to main content

List Submitted Inspection Forms

Returns a list of Submitted Inspection Forms belonging to your account.

info

Submitting inspection forms through the API is not currently supported.

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

  • started_at date

    The date and time at which this Inspection Form was started.

  • submitted_at date

    The date and time at which this Inspection Form was submitted.

  • date string

    The date on which this Inspection Form was submitted, formatted as "Mon DD, YYYY"

  • failed_items integer

    The number of failed items on this Inspection Form.

  • vehicle_id integer

    Possible values: >= 1

  • starting_latitude float

    The latitude at which this Inspection Form was started.

  • starting_longitude float

    The longitude at which this Inspection Form was started.

  • submitted_latitude float

    The latitude at which this Inspection Form was submitted.

  • submitted_longitude float

    The longitude at which this Inspection Form was submitted.

  • duration string

    The duration of time in words (eg; 15 minutes, about 1 hour) between when this Inspection Form was started and when it was submitted.

  • inspection_form object
  • id integer

    Possible values: >= 1

  • title string

    The title of the Inspection Form.

  • description string

    The description of the Inspection Form.

  • contact_id NullableId

    Possible values: >= 1

  • user string

    The full name of the User that submitted this Inspection Form.

  • submitted_inspection_items object[]
  • result object
  • label string

    The label that indicates the result of the Inspection Item.

  • id integer

    Possible values: >= 1

  • comments_count integer

    The number of Comments related to this Inspection Item.

  • images_count integer

    The number of Images related to this Inspection Item.

  • submitted_inspection_form_id integer

    Possible values: >= 1

  • latitude float

    The latitude at which this Inspection Item was submitted.

  • longitude float

    The longitude at which this Inspection Item was submitted.

  • inspection_item object
  • label string

    The label or name of the Inspection Item.

  • type string

    Possible values: [InspectionDateItem, InspectionDatetimeItem, InspectionDropdownItem, InspectionFreeTextItem, InspectionMeterEntryItem, InspectionNumericItem, InspectionPassFailItem, InspectionPhotoItem, InspectionSectionItem, InspectionSignatureItem, InspectionSingleCheckboxItem]

    The type or category of the Inspection Item.

  • fail_label string

    The label for a "Fail" result.

  • pass_label string

    The label for a "Pass" result.

  • dropdown_options object[]

    An array of options for an InspectionDropdownItem.

  • label string

    The label or name of the Inspection Item.

  • position integer

    The position or order of the Inspection Item within the form.

  • fail_if_chosen boolean

    Indicates whether the inspection should fail if this item is chosen.

  • comments object[]

    A list of the comments made on this record.

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

  • commentable_type CommentableType

    Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]

    The type of record that the Comment will be left on. Must be associated with a matching commentable_id.

  • commentable_id integer

    Possible values: >= 1

  • user_id integer

    Possible values: >= 1

  • title string deprecated

    The title of the Comment.

  • comment string

    The content of the Comment message body.

  • user_full_name string

    The full name of the User who created the Comment.

  • user_image_url string

    The image url for the User who created the Comment.

  • rich_content object
  • html_content string

    The comment message body rendered as HTML.

  • with_mentions boolean

    Indicates if the message body contains @mentions.

  • comments_count integer

    The number of comments made on this record.

  • images object[]

    A list of the images attached to this record.

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

  • imageable_id integer

    Possible values: >= 1

  • imageable_type ImageableType

    Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]

  • file_name string

    The name of the image file.

  • file_mime_type Image MIME Type

    Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/gif, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]

  • file_size number

    The size of the image file in bytes.

  • file_url string

    The URL to access the image file.

  • full_url string

    The full URL to access the image file, including any necessary authentication or parameters.

  • images_count integer

    The number of images attached to this record.

Loading...