Events

Retrieve Events

This method retrieves events 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 “2026-01-30” for filter_by_start_date_greater_than_or_equal_to and the value “1” for filter_by_event_format_id, you’ll get back all the events in your workspace that have their start date greater than or equal to Jan 30, 2026 AND have their format set to In-Person. Also, you can only pass in one value for each filter parameter; this means that you can’t pass in “1, 2” as the value for the filter_by_event_star_rating filter parameter expecting to get back all the events that have a 1-star or a 2-star rating.

filter_by_custom_event_field__custom_NNNNNN (replace NNNNNN with the id): This is a special filter that lets you filter down your events based on a value of a Custom Text field or a Custom Dropdown field under the Event Information tab, Event Booth tab, or the Special Event tab. To use this filter, you’ll need the field name for the custom text field or custom dropdown field. You can obtain a list of field names for custom event fields in your workspace from the following endpoint: /v1/references/event_custom_fields. For example, if you have configured a custom dropdown field called “Region” under the Event information tab, and its field name is “custom_123456” and you would like to filter your events to include only ones that have “Northeast” selected for that custom dropdown field, pass in “filter_by_custom_event_field__custom_123456” as the parameter name and “Northeast” as its parameter value. Note: You can only filter down based on one custom event field (and it has to be either a custom text field or a custom dropdown field). A request with more than one custom-field filter is rejected with an error. If your workspace has no custom text field or custom dropdown field with the id in the parameter name, the request is rejected with an error.

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

get/v1/events

Request

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

Query parameters

filter_by_event_name_contains_textstring

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

filter_by_start_date_greater_than_or_equal_tostring date

Only include events that have their start date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD

filter_by_start_date_smaller_than_or_equal_tostring date

Only include events that have their start date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD

filter_by_end_date_greater_than_or_equal_tostring date

Only include events that have their end date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD

filter_by_end_date_smaller_than_or_equal_tostring date

Only include events that have their end date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD

filter_by_event_participation_type_idinteger

Only include events that have their participation_type_id equal to the value passed in for this filter parameter. To get a list of available event Participation Type Ids in your workspace, refer to this endpoint: /v1/references/event_participation_types

filter_by_event_format_idinteger

Only include events that have their format_id equal to the value passed in for this filter parameter. The following integer values are accepted (1 for In-Person, 2 for Virtual, 3 for Hybrid)

filter_by_event_star_ratingnumber

Only include events that have their star rating equal to the value passed in for this filter parameter. The following integer values are accepted: 0, 1, 2, 3

filter_by_event_tagstring

Only include events that have this tag. For example, you can use this filter to get all the events that have the tag “International”. Note: You can only pass in one tag to filter based on.

filter_by_integration_metadata_field_1string

Only include events that have their integration_metadata_field_1 property equal to the value you pass in for this parameter. Note: An event'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 event (e.g., the "external id" of the event from another system you're integrating with).

filter_by_integration_metadata_field_2string

Only include events that have their integration_metadata_field_2 property equal to the value you pass in for this parameter. Note: An event'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 event (e.g., the "external id" of the event from another system you're integrating with).

filter_by_integration_metadata_field_3string

Only include events that have their integration_metadata_field_3 property equal to the value you pass in for this parameter. Note: An event'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 event (e.g., the "external id" of the event from another system you're integrating with).

filter_by_integration_metadata_field_4string

Only include events that have their integration_metadata_field_4 property equal to the value you pass in for this parameter. Note: An event'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 event (e.g., the "external id" of the event from another system you're integrating with).

filter_by_integration_metadata_field_5string

Only include events that have their integration_metadata_field_5 property equal to the value you pass in for this parameter. Note: An event'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 event (e.g., the "external id" of the event from another system you're integrating with).

hydrate_tasksboolean

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

hydrate_task_sections_listboolean

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

hydrate_event_misc_expenses_and_creditsboolean

Include the list of miscellaneous expenses & credits for each event in the result set. Note: hydrating the event miscellaneous expenses & credits collection for each event 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 miscellaneous expenses and credits for each event in the result set.

hydrate_custom_fieldsboolean

Include the event custom fields (i.e. custom fields that have been added to your workspace) for each event in the result set. Note: hydrating the event custom field collection for each event 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 custom field values for each event in the result set.

event_idinteger

Only include the event that has this id. The result is still a list: it holds that one event, or no events if your workspace has no event with that id. To retrieve a single event object, use /v1/events/info instead. A value that isn't an event id number is rejected with an error.

filter_by_event_start_date_categorystring

Only include the events in one category: "all" (all events), "upcoming" (events that end today or later, including events that are in progress), "past" (events that ended before today), or a year such as "2026" (events that start in that year). "Today" is based on your workspace's time zone. When you pass in one of these values, the start date and end date filters are ignored. To get the list of categories for your workspace (with a category for every year that has events), use /v1/references/event_start_date_categories. Any other value is rejected with an error.

filter_by_custom_field_value_setting_idinteger

Another way to filter events by the value of a Custom Text field or a Custom Dropdown field: pass in the field's id as filter_by_custom_field_value_setting_id and the value to look for as filter_by_custom_field_value_setting_value. You can get the ids of the custom fields you can filter by from /v1/references/filterable_event_custom_fields. Only the events whose value for that field equals the value you pass in are included (the comparison is not case-sensitive and ignores leading and trailing spaces). An id that isn't a custom text field or custom dropdown field in your workspace is rejected with an error.

filter_by_custom_field_value_setting_valuestring

The value to look for in the custom field given in filter_by_custom_field_value_setting_id (see that parameter).

$result_sortstring

Sorts the events 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, events are sorted by start date (earliest first).

$return_event_litesboolean

Return a shorter version of each event (id, exhibitday_url, name, start and end dates, participation type, format, star rating, created and last update timestamps, and the integration metadata fields). Use it for faster responses when you only need to identify events. Note: the hydrate parameters don't apply to these shorter events.

filter_by_last_update_timestamp_greater_than_or_equal_tostring

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

$limitinteger

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

$offsetinteger

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