Skip to main content

List Parts

Returns a list of Parts belonging to your account.

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.

    • manufacturer_part_number object
      oneOf
    • like string required
    • number object
      oneOf
    • like string required
    • upc object
    • eq string required
    • part_category_id object
    • eq string required
    • part_manufacturer_id object
    • 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.

    • id string

      Possible values: [asc, desc]

      Default value: 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
  • manufacturer_part_number object
    oneOf
  • like string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • updated_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • description string

    A description of this Part.

  • manufacturer_part_number string

    The part number from this Part's manufacturer.

  • measurement_unit_id integer

    The id of the Measurement Unit associated with this Part.

  • number string

    The part number being used for this Part within Fleetio.

  • part_category_id integer

    The id of the Part Category associated with this Part.

  • part_manufacturer_id integer

    The id of the Part Manufacturer associated with this Part.

  • upc string

    The Universal Product Code for this Part.

  • unit_cost_cents integer

    The unit cost in cents for this Part.

  • average_unit_cost_cents string

    The average unit cost in cents for this Part. FIFO/LIFO accounts only.

  • default_image_url string
  • archived_at date-time

    The date and time at which this Part was archived.

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

  • custom_fields object

    *Full details on working with Custom Fields here.

  • part_manufacturer object
  • id integer
  • name string

    The name of the Part Manufacturer.

  • description string
  • created_at date-time

    The date and time at which this Part Manufacturer was created.

  • updated_at date-time

    The date and time at which this Part Manufacturer was last updated.

  • part_category object
    oneOf
  • id integer

    Possible values: >= 1

  • tire_category boolean

    Indicates whether part is a tire or not

Loading...