Tasks

Retrieve Task Comments

This method retrieves task comments in your workspace based on various filter criteria. The filter parameters for this method work in conjunction on an “AND-basis”. For example, if you pass in the value “12345” for filter_by_event_id, you’ll get back the comments of all the tasks of the event that has an Id of 12345, and if you pass in a task id for filter_by_task_id, you’ll get back the comments of that task only. You can only pass in one value for each filter parameter. If you don’t pass in any filter, all the task comments in your workspace are returned.

Documentation: https://api.exhibitday.com/Help/V1?epf=2#get-v1-tasks-comments

get/v1/tasks/comments

Request

  • Base URL: https://api.exhibitday.com
  • URL: https://api.exhibitday.com/v1/tasks/comments
  • Auth: one of:
    • API key in header api_key
    • API key in query parameter api_key

Query parameters

filter_by_event_idinteger

Only include task comments for tasks from this given event.

filter_by_task_idinteger

Only include task comments for this specific task.

hydrate_taskboolean

Include the task object for each task comment in the result set. Note: hydrating the task object for each task comment in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the task object for each comment in the result set.

filter_by_commenter_user_idstring

Only include the comments made by this user. Use the user's id from /v1/references/users_and_resources.

$result_sortstring

Sorts the comments by when they were added or last updated. Accepted values: create_timestamp_asc, create_timestamp_desc, last_update_timestamp_asc, last_update_timestamp_desc. Without this parameter, comments are grouped by task (in the same order as the Retrieve Tasks method) and listed oldest first within each task.

filter_by_last_update_timestamp_greater_than_or_equal_tostring

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, 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, so skip ids you already have). Deleted task comments are not returned. Any other value is rejected with an error.

$limitinteger

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.

$offsetinteger

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_formatstring

Pass in "array" to get the results as a plain JSON array (without records_found, total_records, has_more and list_type; the X-Total-Count header still gives the total), or "wrapped_in_array" to get the usual response inside a JSON array.

Headers

If-None-Matchstring

The ETag of a response you already have: while the data is unchanged the API answers 304 Not Modified without a body.

Response

OK

records_foundinteger
total_recordsinteger
has_moreboolean
list_typestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.