---
title: "List Comments"
method: GET
path: "/comments"
tags: ["Comments"]
---

# List Comments

`GET /comments`

## Request

- Base URL: `https://secure.fleetio.com/api`
- URL: `https://secure.fleetio.com/api/comments`
- Auth: API key in header `Authorization` and API key in header `Account-Token`
- TypeScript: <https://skmtc.dev/fleetio/apis/fleetio-developer-api/docs/comments/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of your comments.

## Query parameters

- `start_cursor` string
- `per_page` integer
- `filter` object
  - `commentable_id` EqFilter
    - `eq` string, required
  - `commentable_type` EqFilter
    - `eq` string, required
  - `user_id` EqFilter
    - `eq` string, required
- `sort` object
  - `id` 'asc' | 'desc'
  - `updated_at` 'asc' | 'desc'

## Response `200`

OK

- object
  - `start_cursor` string, nullable: The current start cursor of the records returned.
  - `next_cursor` string, nullable: The next cursor to retrieve the next page of records.
  - `per_page` integer: The maximum 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` union[]: The filters applied to the returned record set.
    - union
      - object
        - `commentable_id` EqFilter
          - `eq` string, required
      - object
        - `commentable_type` EqFilter
          - `eq` string, required
      - object
        - `user_id` EqFilter
          - `eq` string, required
  - `sorted_by` union[]: The sorts applied to the returned record set.
    - union
      - object
        - `updated_at` 'asc' | 'desc'
      - object
        - `id` 'asc' | 'desc'
  - `records` CommentSummary[]
    - `id` integer, required
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `commentable_type` 'Contact' | 'FleetcorCard' | 'FuelEntry' | 'InventoryJournalEntry' | 'Issue' | 'Part' | 'PurchaseOrder' | 'ServiceEntry' | 'ServiceReminder' | 'SubmittedInspectionItem' | 'Vehicle' | 'VehicleAssignment' | 'Vendor' | 'WexCard' | 'WorkOrder', required: The type of record that the Comment will be left on. Must be associated with a matching `commentable_id`.
    - `commentable_id` integer, required
    - `user_id` integer, required
    - `comment` string, required: The content of the Comment message body.
    - `rich_content` object, nullable, required
    - `html_content` string, nullable, required: The comment message body rendered as HTML.
    - `with_mentions` boolean, required: Indicates if the message body contains @mentions.
    - `author` ContactMini, nullable: A Contact
      - `id` integer
      - `email` string, nullable: The Contact's email address.
      - `name` string, nullable: The Contact's full name.
      - `group_id` integer, nullable: If this Contact belongs to a [Group](/docs/api/groups), this will be the Fleetio ID of that `Group`.
      - `employee` boolean, nullable: Whether or not the Contact is an employee.
      - `employee_number` string, nullable: The employee number of the Contact.
      - `default_image_url` string, nullable: The URL of the Contact's default image/profile photo, if any.

## Other responses

- `400`: The format or parameters of the request was invalid
- `401`: Request could not be authenticated
- `500`: Something unexpected happened

## Changes

- **2026-11-06** `49558d744bd7`: 1 info
  - for the `query` request parameter `per_page`, the min was decreased from `2.00` to `1.00`
- **2025-09-06** `6daa53a03224`: 3 breaking, 2 info
  - the response property `records/items/author/default_image_url` became optional for the status `200`
  - the response property `records/items/author/id` became optional for the status `200`
  - the response property `records/items/author/name` became optional for the status `200`
  - added the optional property `records/items/author/employee` to the response with the `200` status
  - …1 more

[Operation history](https://skmtc.dev/fleetio/apis/fleetio-developer-api/changes/comments/get.md)

---

[API](https://skmtc.dev/fleetio/apis/fleetio-developer-api.md) - [All operations](https://skmtc.dev/fleetio/apis/fleetio-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fleetio/apis/fleetio-developer-api/revisions/49558d744bd7?raw)
