TasksComments

Comments

Retrieve a Single Task Comment by ID #

Method
GET
Endpoint
Sample Object

Retrieves information about a specific task comment (using the "id" parameter).

Parameters
Name Type Required? Description Details
id Number Yes
Id of the specific task comment that you would like to retrieve.
$include_record_revision Boolean No
Set to true to include record_revision in the response. Send that value as expected_revision when updating to check for conflicting changes.
Default: false.

Good to know

Retrieves information about a specific task comment (using the "id" parameter). Older path, still accepted: /v1/tasks/comment.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/tasks/comments/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "id": 12345,
  "comment": "Sample comment",
  "comment_created_timestamp": "2026-11-19T17:00:00Z",
  "comment_last_update_timestamp": "2026-11-19T17:00:00Z",
  "commenter": {
    "id": "11111111-2222-4333-8444-555555555555",
    "first_name": "Jane",
    "last_name": "Smith",
    "display_name": "Jane Smith",
    "email": "jane@example.invalid",
    "type": "user",
    "workspace_role": "team_member",
    "is_active": true
  },
  "event_id": null,
  "task_id": 12345,
  "task": {
    "id": 12345,
    "exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=12345",
    "event_task_section_id": null,
    "event_task_section": "Uncategorized",
    "display_rank": 0,
    "name": "Sample task",
    "due_date": null,
    "assignee": null,
    "is_completed": false,
    "task_completed_timestamp": null,
    "task_created_timestamp": "2026-11-19T17:00:00Z",
    "task_last_update_timestamp": "2026-11-19T17:00:00Z"
  }
}
Note: IDs are illustrative; use IDs from your workspace.

Retrieve Task Comments #

Method
GET
Endpoint

Retrieves Task comments in your workspace.

Parameters
Name Type Required? Description Details
filter_by_event_id Number No
Only include task comments for tasks from this given event.
filter_by_task_id Number No
Only include task comments for this specific task.
hydrate_task Boolean No
Set to true to include the Task object with each comment. This increases response size and can slow the request.
Default: false.
filter_by_commenter_user_id String No
Only include the comments made by this user. Use the user's id from /v1/references/users_and_resources.
$result_sort String No
Sorts comments by when they were created or last updated. Omit, or use an unrecognized value, to group comments by Task in the Retrieve Tasks order, oldest first within each Task.
Allowed values: create_timestamp_asc (oldest created first) | create_timestamp_desc (newest created first) | last_update_timestamp_asc (least recently updated first) | last_update_timestamp_desc (most recently updated first)
filter_by_last_update_timestamp_greater_than_or_equal_to String No
Only include task comments that were added or changed on or after this date and time, for example 2026-10-14T18:30:00 (a date alone, such as 2026-10-14, means midnight). Responses give comment_last_update_timestamp in UTC (it ends in Z), and that value can be passed back unchanged; a value without an offset is read as US Eastern time, and any other offset (e.g., 2026-10-14T18:30:00-04:00) is converted. To sync changes, process and save every page before advancing the cursor. Save the latest comment_last_update_timestamp you receive and pass it in next time (task comments changed at exactly that time come back again, upsert every returned record by id, including boundary records). Deleted task comments are not returned. Any other value is rejected with an error.
$limit Number No
The most task comments to return (a whole number of 1 or more). Use it with $offset to read a long list in pages: total_records in the response counts every matching task comment and has_more is true while more pages follow (the X-Total-Count header carries the total too). Without $limit, every matching task comment is returned.
$offset Number No
How many task comments to skip before the first one returned (a whole number; 0 by default). For the next page, add the number of task comments you received to $offset.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
Allowed values: array | wrapped_in_array

Good to know

Find Task comments in your workspace. Comments must match every filter you supply. Use filter_by_event_id for comments on Tasks from one Event, or filter_by_task_id for comments on one Task. Each filter accepts one value. Omit all filters to retrieve comments across your workspace.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/tasks/comments" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "task_comment",
  "list_data": [
    {
      "id": 12345,
      "comment": "Sample comment",
      "comment_created_timestamp": "2026-11-19T17:00:00Z",
      "comment_last_update_timestamp": "2026-11-19T17:00:00Z",
      "commenter": {
        "id": "11111111-2222-4333-8444-555555555555",
        "first_name": "Jane",
        "last_name": "Smith",
        "display_name": "Jane Smith",
        "email": "jane@example.invalid",
        "type": "user",
        "workspace_role": "team_member",
        "is_active": true
      },
      "event_id": null,
      "task_id": 12345,
      "task": {
        "id": 12345,
        "exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=12345",
        "event_task_section_id": null,
        "event_task_section": "Uncategorized",
        "display_rank": 0,
        "name": "Sample task",
        "due_date": null,
        "assignee": null,
        "is_completed": false,
        "task_completed_timestamp": null,
        "task_created_timestamp": "2026-11-19T17:00:00Z",
        "task_last_update_timestamp": "2026-11-19T17:00:00Z"
      }
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace.

Add a Comment to a Task #

Method
POST
Endpoint

Adds a comment to a Task.

Parameters
Name Type Required? Description Details
task_id Number Yes
The id of the task you would like to add the comment to.
comment String Yes
The text of the comment you would like to add. Only accepts plain text. Any HTML tags will be stripped. Newline characters are displayed as line breaks in ExhibitDay and remain newline characters in API responses. Accepts up to 15,000 characters (some symbols count as two characters).
Code Samples
curl -X POST "https://api.exhibitday.com/v1/tasks/comments" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"task_id\":12345,\"comment\":\"Sample comment\"}"

Example response

{
  "id": 23456,
  "comment": "Sample comment",
  "comment_created_timestamp": "2026-11-19T17:00:00Z",
  "comment_last_update_timestamp": "2026-11-19T17:00:00Z",
  "commenter": {
    "id": null,
    "first_name": "ExhibitDay",
    "last_name": "API",
    "display_name": "ExhibitDay API",
    "email": null,
    "type": null,
    "workspace_role": null,
    "is_active": true
  },
  "event_id": null,
  "task_id": 12345,
  "task": {
    "id": 12345,
    "exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=12345",
    "event_task_section_id": null,
    "event_task_section": "Uncategorized",
    "display_rank": 0,
    "name": "Sample task",
    "due_date": null,
    "assignee": null,
    "is_completed": false,
    "task_completed_timestamp": null,
    "task_created_timestamp": "2026-11-19T17:00:00Z",
    "task_last_update_timestamp": "2026-11-19T17:00:00Z"
  }
}
Note: IDs are illustrative; use IDs from your workspace.

Update a Task Comment #

Method
PATCH
Endpoint

Updates an existing Task comment.

Parameters
Name Type Required? Description Details
id Number Yes
The Id of the task comment you would like to update.
comment String Yes
The text that will replace the existing comment, including any formatting previously applied in ExhibitDay. Only accepts plain text. Any HTML tags will be stripped. Newline characters are displayed as line breaks in ExhibitDay and remain newline characters in API responses. Accepts up to 15,000 characters (some symbols count as two characters). A comment cannot be blank: an empty value (or null) is rejected with an error.
expected_revision String No
The record_revision returned when you retrieved this record. Include it to avoid overwriting someone else's changes. Omit it to skip this check.

Good to know

Updates the text of a given comment on a task. A comment cannot be moved to another task. If the text you send is the comment's current text, nothing is saved: the comment, its last update time and its history stay unchanged. Older path, still accepted: /v1/tasks/comment.

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/tasks/comments" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"comment\":\"Updated comment\"}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Task Comment Update Successful. Task comment updated via API.",
  "errors": []
}

Delete a Task Comment #

Method
DELETE
Endpoint

Deletes an existing Task comment.

Parameters
Name Type Required? Description Details
id Number Yes
The Id of the task comment you would like to delete.

Good to know

Permanently deletes a task comment. It cannot be undone. Older path, still accepted: /v1/tasks/comment.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/tasks/comments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Task Comment Deleted",
  "errors": []
}