Skip to main content

List Equipment

Returns a list of your Equipment. Defaults to only returning non-archived Equipment, but you can include archived Equipment in the results as well.

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.

    • brand object
      oneOf
    • like string required
    • name object
      oneOf
    • like string required
    • model object
      oneOf
    • like string required
    • serial_number object
      oneOf
    • like string required
    • labels object
    • include string required
    • current_location_entry_id object
    • eq string required
    • in_service_date object
      oneOf
    • eq string required
    • out_of_service_date object
      oneOf
    • eq string required
    • purchase_date object
      oneOf
    • 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.

    • in_service_date string

      Possible values: [asc, desc]

    • out_of_service_date string

      Possible values: [asc, desc]

    • purchase_date 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
  • brand object
    oneOf
  • like string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • in_service_date string

    Possible values: [asc, desc]

  • records Equipment[]
  • id integer
  • name string

    The name for this Equipment.

  • brand string

    The name of the brand which makes this Equipment.

  • model string

    The model name of this Equipment.

  • serial_number string

    The serial number of this Equipment.

  • equipment_type_id integer
  • type_name string

    The name of the associated Equipment Type.

  • equipment_status_id integer
  • status_name string

    The name of the associated Equipment Status.

  • group_id integer
  • purchase_vendor_id integer
  • purchase_price_cents integer

    The purchase price in cents.

  • purchase_date date

    The date on which the Equipment was purchased.

  • estimated_resale_price_cents integer

    The estimated resale price in cents of this Equipment.

  • warranty_expiration_date date

    The date on which the Equipment warranty expires.

  • purchase_comments string

    Any comments about the purchase of this Equipment.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • in_service_date date

    The date on which the Equipment was put into service.

  • estimated_service_life integer

    The estimated duration in months of the service life for this Equipment.

  • out_of_service_date date

    The estimated date on which the Equipment will be retired from service.

  • archived_at date-time

    The date and time at which the Equipment was archived.

  • status_color string

    The color of the associated Equipment Status.

  • purchase_vendor object

    A Vendor

  • name string

    The name of the Vendor.

  • phone string

    The phone number of the Vendor.

  • city string

    The city of the Vendor.

  • region string

    The region, state, province, or territory of the Vendor.

  • postal_code string

    The postal code or ZIP code of the Vendor.

  • country string

    The country of the Vendor.

  • external_id string

    The external identifier of the Vendor.

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

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

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

  • default_image_url string

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

  • assetable_type string

    The type of assetable object.

  • comments_count integer

    The number of Comments associated with this Equipment.

  • documents_count integer

    The number of documents associated with this Equipment.

  • images_count integer

    The number of images associated with this Equipment.

  • is_watched boolean

    Default value: false

    Indicates whether this Equipment is being watched.

  • watchers_count integer

    The number of users watching this Equipment.

Loading...