Skip to main content

List Comments

Returns a list of your comments.

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.

    • commentable_id object
    • eq string required
    • commentable_type object
    • eq string required
    • user_id object
    • eq string required
  • sort object

    The fields and direction to sort the results by.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • updated_at string

      Possible values: [asc, desc]




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


  • commentable_id object
  • eq string
  • sorted_by object[]

    The sorts applied to the returned record set.


  • updated_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • created_at date-time
  • updated_at date-time
  • 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
  • user_id integer
  • comment string

    The content of the Comment message body.

  • rich_content object
  • html_content string

    The comment message body rendered as HTML.

  • with_mentions boolean

    Indicates if the message body contains @mentions.

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