FleetbaseFleetbase
Start Free Trial

Comments

Comments attach discussion to Fleetbase resources or reply to existing comments. Use comment endpoints to create threaded context around orders, files, operational records, and other subject models.

The Comment object

A comment stores authored text against a subject resource or as a reply to another comment.
Attributes
idstringoptional

Public identifier of the comment.

contentstringoptional

Comment body.

tagsarray of stringsoptional

Tags associated with the comment.

metaobjectoptional

Arbitrary metadata stored with the comment.

authorobjectoptional

User that authored the comment.

repliesarray of objectsoptional

Nested replies to the comment.

editablebooleanoptional

Whether the current session user can edit the comment.

updated_attimestampoptional

Time the comment was last updated.

created_attimestampoptional

Time the comment was created.

deleted_attimestampoptional

Time the comment was deleted, when soft deleted.

The Comment object
{
  "id": "comment_8JVZr4q",
  "content": "Please confirm the delivery window.",
  "tags": [],
  "meta": {},
  "author": {
    "id": "user_8xP2L1d",
    "name": "Alex Rivera"
  },
  "replies": [],
  "editable": true,
  "updated_at": "2026-05-07T09:30:00Z",
  "created_at": "2026-05-07T09:30:00Z",
  "deleted_at": null
}
POST/v1/comments

Create Comment

Creates a comment on a subject resource or as a reply to an existing comment. Provide either a subject reference or a parent comment ID with the comment content.

Body parameters
contentstringrequired

Comment body.

subjectobjectoptional

Subject resource receiving the comment. Provide this object when creating a top-level comment.

idstringrequired

Public ID of the subject resource.

typestringrequired

Mutation type or resource type used to resolve the subject model.

subject_idstringoptional

Public ID of the subject resource. Use with subject_type as an alternative to subject.

subject_typestringoptional

Mutation type or resource type used to resolve the subject model. Use with subject_id.

parentstringoptional

Public ID of the parent comment when creating a reply.

POST/v1/comments
curl -X POST https://api.fleetbase.io/v1/comments \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "Example comment",
  "subject": {
    "id": "{{subject_id}}",
    "type": "{{subject_type}}"
  }
}'
PUT/v1/comments/:id

Update Comment

Updates the content of an existing comment. The subject and parent linkage are not changed by this endpoint.

Body parameters
contentstringrequired

Updated comment body.

PUT/v1/comments/:id
curl -X PUT https://api.fleetbase.io/v1/comments/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "Updated comment"
}'
GET/v1/comments

Query Comments

Returns comments for the current organization. Use query parameters to filter, sort, and paginate the result set.

Query parameters
limitstringoptional

Limit value for this comments request.

offsetstringoptional

Offset value for this comments request.

sortstringoptional

Sort value for this comments request.

GET/v1/comments
curl https://api.fleetbase.io/v1/comments?limit=25&offset=0&sort=created_at \
  -H "Authorization: Bearer flb_live_…"
GET/v1/comments/:id

Retrieve Comment

Retrieves a comment by ID, including its author and any nested replies returned by the API resource.

GET/v1/comments/:id
curl https://api.fleetbase.io/v1/comments/:id \
  -H "Authorization: Bearer flb_live_…"
DELETE/v1/comments/:id

Delete Comment

Deletes a comment by ID. The response returns a deleted-resource envelope for the removed comment.

DELETE/v1/comments/:id
curl -X DELETE https://api.fleetbase.io/v1/comments/:id \
  -H "Authorization: Bearer flb_live_…"
Comments | Fleetbase