Search API documentation

Type to search the API docs.

Search Tasks by Name, Details, Assignee and Due Date

Find Tasks by name or details, then narrow them to an Event, an Assignee, a Due Date range or what's still Incomplete.

Example use case

A few weeks before a show, you want every Incomplete Task about the booth, the Tasks whose Details mention the hotel block, and everything still on your coordinator's list.

What you'll end up with

The Tasks that match your search, with their IDs, Events, Due Dates and Assignees.

Before you start

Have a workspace API key. To narrow the search, have an Event ID or the ID of the person assigned the Tasks.

Good to know

A Task must match every filter you send. Tasks come back in Task Board order unless you choose a sort.

At a glance

Time to try

About 10 minutes

Effect on your data

Read-only

Endpoints

1

The requests only read Tasks. They change nothing.

How it works

  1. Search Task names, or the text in each Task's Details.
  2. Narrow the list to an Event, an Assignee, a Due Date range or what's still Incomplete.
  3. Combine filters and read every page.

How search matching works

  • Searches ignore letter case, accents and spaces before or after your text. cafe, Café and CAFE find the same Tasks.
  • %, _ and [ match themselves. Search for them like any other character.
  • A blank name or Details search is ignored, so it doesn't narrow the list.
  • Name and Details searches find your text anywhere in the saved text.
  • Details are saved as formatted text (HTML). The search turns common codes, such as curly apostrophes, ampersands (&), non-breaking spaces and line breaks, into plain characters, so the words you type match. A word with formatting inside it, such as one bold letter, may still not match.

Step 1: Search by part of the Task name

Find Incomplete Tasks with booth anywhere in the name. The later steps add $return_task_lites=true to keep each result short.

curl -X GET "https://api.exhibitday.com/v1/tasks?filter_by_task_name_contains_text=booth&filter_by_incomplete_only=true&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Example response (shortened)

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_data": [
    {
      "id": 12345,
      "name": "Sample task",
      "due_date": null,
      "is_completed": false
    }
  ]
}

Check: Leave out filter_by_incomplete_only to include Completed Tasks too. Each result's event tells you which show it belongs to.

Step 2: Search the Details

Find Tasks whose Details mention hotel block. Send filter_by_task_details_contains_text with plain words, the way you'd type them on the website.

curl -X GET "https://api.exhibitday.com/v1/tasks?filter_by_task_details_contains_text=hotel%20block&%24return_task_lites=true&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Check: Task Lite results leave out the Details. Leave out $return_task_lites to read details, which comes back as the saved formatted text (HTML).

Step 3: Find an Assignee's Incomplete Tasks for one Event

Send the Event ID and the Assignee's user ID. This finds the Incomplete Tasks for Event 12345 assigned to that person.

curl -X GET "https://api.exhibitday.com/v1/tasks?filter_by_event_id=12345&filter_by_assignee_user_id=11111111-2222-4333-8444-555555555555&filter_by_incomplete_only=true&%24return_task_lites=true&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Check: Treat user IDs as text. Find a person's ID with Find Users and Resources by Name, Email or Role. To find unassigned Tasks, send filter_by_assignee_user_id=null.

Step 4: Find Tasks due in a date range

Find Incomplete Tasks with a Due Date in March 2027. Send dates as YYYY-MM-DD.

curl -X GET "https://api.exhibitday.com/v1/tasks?filter_by_due_date_greater_than_or_equal_to=2027-03-01&filter_by_due_date_smaller_than_or_equal_to=2027-03-31&filter_by_incomplete_only=true&%24return_task_lites=true&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Check: You can also send today, yesterday or tomorrow. They use your workspace's time zone. Tasks with no Due Date aren't included.

Step 5: Combine filters and read every page

Add any of the Tasks list's other filters. They work together with your searches. This request asks for the second page of Completed Tasks in the Task Board's General Tasks section.

curl -X GET "https://api.exhibitday.com/v1/tasks?filter_by_general_tasks_only=true&filter_by_completed_only=true&%24return_task_lites=true&%24limit=50&%24offset=50" -H "Authorization: Bearer YOUR_API_KEY"

Other filters you can add:

To findSend
Tasks for one Eventfilter_by_event_id
Tasks in the General Tasks section, not tied to an Eventfilter_by_general_tasks_only=true (not with filter_by_event_id)
Incomplete or Completed Tasksfilter_by_incomplete_only=true, or filter_by_completed_only=true
Tasks with no Due Datefilter_by_no_due_date=true (not with the Due Date filters)
Tasks that have an Assigneefilter_by_has_assignee=true
Tasks with a person tagged as a Contributorfilter_by_contributor_user_ids with one ID or an array of IDs
Tasks with all of several ContributorsAdd filter_by_contributor_user_ids_match_type=all (the default is any)
Tasks a person completedfilter_by_completer_user_id
Your system's ID in an integration fieldfilter_by_integration_metadata_field_1 (fields 1 to 5)
Tasks added or changed since a timefilter_by_last_update_timestamp_greater_than_or_equal_to
A different order$result_sort: create_timestamp_asc, create_timestamp_desc, last_update_timestamp_asc or last_update_timestamp_desc

Check: Start with $offset=0. While has_more is true, ask for the next page with the same filters and sort, and add 50 to $offset. total_records counts every matching Task.

Try it

Before running the example

ValueWhat to put in it
YOUR_API_KEYYour workspace API key. Keep it out of shared code and logs.
filter_by_task_name_contains_textPart of a Task name in your workspace. The example uses booth.
$limit and $offsetThe example reads up to 50 matches starting at offset 0.

Copy the complete example in your language and run it. To try another search, change the request to match one of the steps above.

Complete example program

Code Samples
curl -X GET "https://api.exhibitday.com/v1/tasks?filter_by_task_name_contains_text=booth&filter_by_incomplete_only=true&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "task",
  "list_data": [
    {
      "id": 12345,
      "exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=12345",
      "event_task_section_id": null,
      "event_task_section": null,
      "display_rank": 0,
      "name": "Sample task",
      "due_date": null,
      "assignee": null,
      "assigned_by": null,
      "contributors": [
        {
          "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
        },
        {
          "id": "66666666-7777-4888-8999-aaaaaaaaaaaa",
          "first_name": "Alex",
          "last_name": "Morgan",
          "display_name": "Alex Morgan",
          "email": "alex@example.invalid",
          "type": "user",
          "workspace_role": "team_member",
          "is_active": true
        }
      ],
      "is_completed": false,
      "task_completed_timestamp": null,
      "task_completed_by": null,
      "details": "",
      "comments": null,
      "event": null,
      "task_created_by": {
        "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
      },
      "task_created_timestamp": "2026-11-22T17:00:00Z",
      "task_last_update_timestamp": "2026-11-22T17:00:00Z",
      "integration_metadata_field_1": "",
      "integration_metadata_field_2": "",
      "integration_metadata_field_3": "",
      "integration_metadata_field_4": "",
      "integration_metadata_field_5": ""
    }
  ]
}
Note: GET /v1/tasks - HTTP 200. One page of Incomplete Tasks whose names contain booth. Use your own search text and keep the returned Task IDs.

The curl example uses Bash. Node.js needs version 18 or later (save as .mjs). Python uses Requests. C# needs a .NET 8 console project (Program.cs). Java needs Java 11 or later (ExhibitDayExample.java). PHP needs PHP with cURL. Ruby and Go use their standard libraries.

Things to keep in mind

  • Without $result_sort, Tasks are grouped by Event in Event start date order, then listed in their Task Board order.
  • Tasks can't be assigned to Resources. To pick an Assignee, use GET /v1/references/users_and_resources with filter_by_can_have_tasks_assigned=true.
  • Task Lite results are faster and leave out Details, Contributors and comments. Use full results when you need them.
  • Integration field filters match the whole value. They ignore letter case and spaces before or after it, but accents count. A blank value is ignored.