Skip to main content

List Tires

Returns a list of Tires

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.

    • axle_config_id object

      Filter by Axle Configuration id.

      oneOf

    • eq string required
    • vehicle_id object

      Filter by Vehicle id.

      oneOf

    • eq string required
    • part_id object

      Filter by Part id.

      oneOf

    • eq string required
    • tire_position_id object

      Filter by Tire Position id.

      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.

    • 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

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

  • 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

  • axle_config_id object

    Filter by Axle Configuration id.

    oneOf

  • eq string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf

  • created_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer

    The id of the Tire

  • tire_position_id integer

    A Tire Position id. The existence of a tire_position_id indicates this Tire is currently installed. Similiarly, if this value is null, then this Tire is not currently installed on a Vehicle.

  • part_id integer

    A Part id.

  • axle_config_id integer

    An Axle Configuration id. The existence of a axle_config_id indicates this Tire is currently installed. Similiarly, if this value is null, then this Tire is not currently installed on a Vehicle.

  • pressure integer

    The air pressure of the Tire in pounds per square inch (PSI)

  • tread_depth integer

    The tread depth of the Tire in /32 inch.

  • current_meter number

    The current meter of the Tire.

  • created_at date-time

    When the Tire was created

  • updated_at date-time

    When the Tire was last updated

Loading...