---
title: "Retrieve Tasks"
method: GET
path: "/v1/tasks"
tags: ["Tasks"]
---

# Retrieve 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`

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

## Query parameters

- `filter_by_event_id` integer
- `filter_by_general_tasks_only` boolean
- `filter_by_incomplete_only` boolean
- `filter_by_completed_only` boolean
- `filter_by_no_due_date` boolean
- `filter_by_due_date_greater_than_or_equal_to` string, date
- `filter_by_due_date_smaller_than_or_equal_to` string, date
- `filter_by_has_assignee` boolean
- `filter_by_assignee_user_id` string
- `filter_by_task_name_contains_text` string
- `filter_by_integration_metadata_field_1` string
- `filter_by_integration_metadata_field_2` string
- `filter_by_integration_metadata_field_3` string
- `filter_by_integration_metadata_field_4` string
- `filter_by_integration_metadata_field_5` string
- `hydrate_task_comments` boolean
- `filter_by_completer_user_id` string
- `$result_sort` string
- `$return_task_lites` boolean
- `filter_by_last_update_timestamp_greater_than_or_equal_to` string
- `$limit` integer
- `$offset` integer
- `$result_format` string
- `$on_error_return_empty_result` boolean

## Headers

- `If-None-Match` string

## Response `200`

OK

- union
  - TasksList, nullable
    - `records_found` integer
    - `total_records` integer
    - `has_more` boolean
    - `list_type` string, nullable
    - `list_data` Task[], nullable
      - `id` integer
      - `exhibitday_url` string, nullable
      - `event_task_section_id` integer, nullable
      - `event_task_section` string, nullable
      - `display_rank` integer
      - `name` string, nullable
      - `due_date` string, nullable
      - `assignee` AspNetUserReferenced, nullable
        - `id` string, nullable
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `email` string, nullable
      - `is_completed` boolean
      - `task_completed_timestamp` string, date-time, nullable
      - `task_completed_by` AspNetUserReferenced, nullable
        - `id` string, nullable
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `email` string, nullable
      - `details` string, nullable
      - `comments` TaskCommentReferenced[], nullable
        - `id` integer
        - `comment` string, nullable
        - `comment_created_timestamp` string, date-time
        - `comment_last_update_timestamp` string, date-time
        - `commenter` AspNetUserReferenced, nullable
          - `id` string, nullable
          - `first_name` string, nullable
          - `last_name` string, nullable
          - `email` string, nullable
      - `event` EventReferenced, nullable
        - `id` integer
        - `exhibitday_url` string, nullable
        - `name` string, nullable
        - `start_date` string, nullable
        - `end_date` string, nullable
        - `participation_type_id` integer
        - `participation_type` string, nullable
        - `format_id` integer
        - `format` string, nullable
        - `event_created_timestamp` string, date-time, nullable
        - `event_last_update_timestamp` string, date-time
      - `task_created_by` AspNetUserReferenced, nullable
        - `id` string, nullable
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `email` string, nullable
      - `task_created_timestamp` string, date-time
      - `task_last_update_timestamp` string, date-time
      - `integration_metadata_field_1` string, nullable
      - `integration_metadata_field_2` string, nullable
      - `integration_metadata_field_3` string, nullable
      - `integration_metadata_field_4` string, nullable
      - `integration_metadata_field_5` string, nullable
  - TaskLitesList, nullable
    - `records_found` integer
    - `total_records` integer
    - `has_more` boolean
    - `list_type` string, nullable
    - `list_data` TaskLite[], nullable
      - `id` integer
      - `exhibitday_url` string, nullable
      - `display_rank` integer
      - `name` string, nullable
      - `due_date` string, nullable
      - `assignee_user_id` string, nullable
      - `is_completed` boolean
      - `task_completed_timestamp_est` string, date-time, nullable
      - `task_completed_by_user_id` string, nullable
      - `event` EventReferenced, nullable
        - `id` integer
        - `exhibitday_url` string, nullable
        - `name` string, nullable
        - `start_date` string, nullable
        - `end_date` string, nullable
        - `participation_type_id` integer
        - `participation_type` string, nullable
        - `format_id` integer
        - `format` string, nullable
        - `event_created_timestamp` string, date-time, nullable
        - `event_last_update_timestamp` string, date-time
      - `task_created_by_user_id` string, nullable
      - `task_created_timestamp` string, date-time
      - `task_last_update_timestamp` string, date-time
      - `integration_metadata_field_1` string, nullable
      - `integration_metadata_field_2` string, nullable
      - `integration_metadata_field_3` string, nullable
      - `integration_metadata_field_4` string, nullable
      - `integration_metadata_field_5` string, nullable

## Other responses

- `304`: Not Modified: If-None-Match named the current ETag, so there is no body.
- `400`: Bad Request: a missing or invalid parameter, or a change that is not allowed (error_code says which).
- `401`: Unauthorized: the api_key is missing or invalid, or API access is not enabled for the workspace.
- `404`: Not Found: no object with that id in your workspace, or an unknown URL or method.
- `429`: Too Many Requests: the rate limit was exceeded.
- `500`: Unexpected Internal Error.

---

[API](https://skmtc.dev/exhibitday/apis/exhibitday-api.md) · [All operations](https://skmtc.dev/exhibitday/apis/exhibitday-api/llms.txt) · [OpenAPI document](https://skmtc.dev/exhibitday/apis/exhibitday-api/revisions/a35e95422b0a?raw)
