Tasks

Retrieve Tasks

This method retrieves tasks 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 “true” for filter_by_no_due_date and value “12345” for filter_by_event_id, you’ll get back all the tasks with no due date for the event that has an Id of 12345. Also, you can only pass in one value for each filter parameter; this means that you can’t pass in “12345, 56789” as the value for the filter_by_event_id filter parameter expecting to get back all the tasks for the two events 12345 and 56789.

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

get/v1/tasks

Request

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

Query parameters

filter_by_event_idinteger

Only include tasks from this given event.

filter_by_general_tasks_onlyboolean

Only include general tasks (tasks on the main task board that do not belong to a particular event). Note: this filter cannot be used in conjunction with the filter_by_event_id filter.

filter_by_incomplete_onlyboolean

If you pass in the value "true" for this parameter, the result will only include tasks that are NOT marked as Completed.

filter_by_completed_onlyboolean

If you pass in the value "true" for this parameter, the result will only include tasks that are marked as Completed.

filter_by_no_due_dateboolean

If you pass in the value "true" for this parameter, the result will only include tasks that do not have a due date set.

filter_by_due_date_greater_than_or_equal_tostring date

Only include tasks that have a due date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD. You can also pass in "today", "yesterday" or "tomorrow" (based on your workspace's time zone). Note: this filter cannot be used in conjunction with the filter_by_no_due_date filter.

filter_by_due_date_smaller_than_or_equal_tostring date

Only include tasks that have a due date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD. You can also pass in "today", "yesterday" or "tomorrow" (based on your workspace's time zone). Note: this filter cannot be used in conjunction with the filter_by_no_due_date filter.

filter_by_has_assigneeboolean

Only include tasks that have an assignee. Unassigned tasks will get excluded.

filter_by_assignee_user_idstring

Only include tasks that are assigned to this user. You can get a list of UserIds in your workspace from the /v1/references/users_and_resources endpoint. Note: If you want to retrieve the tasks that are unassigned, include this parameter and pass in the word "null" as the value for it.

filter_by_task_name_contains_textstring

Only include tasks that have the given text in the task Name. For example: If you want to retrieve all the tasks that have the word “order” in the task Name field, pass in the value “order” for the filter_by_task_name_contains_text parameter. Note: this text search is not case-sensitive.

filter_by_integration_metadata_field_1string

Only include tasks that have their integration_metadata_field_1 property equal to the value you pass in for this parameter. Note: A task's integration_metadata_field_1 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).

filter_by_integration_metadata_field_2string

Only include tasks that have their integration_metadata_field_2 property equal to the value you pass in for this parameter. Note: A task's integration_metadata_field_2 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).

filter_by_integration_metadata_field_3string

Only include tasks that have their integration_metadata_field_3 property equal to the value you pass in for this parameter. Note: A task's integration_metadata_field_3 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).

filter_by_integration_metadata_field_4string

Only include tasks that have their integration_metadata_field_4 property equal to the value you pass in for this parameter. Note: A task's integration_metadata_field_4 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).

filter_by_integration_metadata_field_5string

Only include tasks that have their integration_metadata_field_5 property equal to the value you pass in for this parameter. Note: A task's integration_metadata_field_5 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).

hydrate_task_commentsboolean

Include the comments collection for each task in the result set. Note: hydrating the comments collection for each task 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 list of comments for each task in the result set.

filter_by_completer_user_idstring

Only include the tasks that were completed by this user. Use the user's id from /v1/references/users_and_resources. You can only pass in one id.

$result_sortstring

Sorts the tasks 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, tasks are grouped by event (in event start date order) and listed in their task board order within each event.

$return_task_litesboolean

Return a shorter version of each task (id, exhibitday_url, display_rank, name, due_date, assignee_user_id, is_completed, completion time and user, the event, created by, created and last update timestamps, and the integration metadata fields). Use it for faster responses when you only need to identify tasks. Note: task comments are not included in these shorter tasks. In them the completion time is named task_completed_timestamp_est, but it is UTC like every other timestamp (the same value as task_completed_timestamp in the full task).

filter_by_last_update_timestamp_greater_than_or_equal_tostring

Only include tasks 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 task_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 task_last_update_timestamp you receive and pass it in next time (tasks changed at exactly that time come back again, so skip ids you already have). Deleted tasks are not returned. Any other value is rejected with an error.

$limitinteger

The most tasks 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 and has_more is true while more pages follow (the X-Total-Count header carries the total too). Without $limit, every matching task is returned.

$offsetinteger

How many tasks to skip before the first one returned (a whole number; 0 by default). For the next page, add the number of tasks 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.

$on_error_return_empty_resultboolean

If the request has an error (e.g., an invalid filter value), return an empty list with HTTP status 200 instead of an error response.

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

OR

Changes

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