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]

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

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

  • MOD1
  • MOD2
  • MOD3

  ---

  commentable_id object

  eq string

  commentable_type object

  eq string

  user_id object

  eq string
• sorted_by object[]

  The sorts applied to the returned record set.

  anyOf

  • MOD1
  • MOD2

  ---

  updated_at string

  Possible values: [asc, desc]

  id 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

  anyOf

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

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "commentable_id": {
        "eq": "string"
      }
    },
    {
      "commentable_type": {
        "eq": "string"
      }
    },
    {
      "user_id": {
        "eq": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2024-04-24",
      "updated_at": "2024-04-24",
      "commentable_type": "Contact",
      "commentable_id": 0,
      "user_id": 0,
      "comment": "string",
      "rich_content": {},
      "html_content": "string",
      "with_mentions": true,
      "author": {
        "id": 0,
        "email": "string",
        "name": "string",
        "group_id": 0,
        "default_image_url": "string"
      }
    }
  ]
}

The format or parameters of the request was invalid

application/json

• Schema
• Example (from schema)

---

Schema

• errors object

  type

  items string

{
  "errors": {}
}

Request could not be authenticated

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Loading...