Financials

Retrieve Event Costs

If a specific Event Id is passed in (using the "filter_by_event_id" parameter), then only the costs for that event are returned. Otherwise, all costs for all events are returned. The "cost_subtype" property contains the selected Booth Service type or the Event Activity type. Other Booth Services use "Other"; Other activities use their category name, including "Presentation (Other)". General activities and other cost types return null. The subtype is separate from "details", which describes the item.

Documentation: https://api.exhibitday.com/Help/V1?epf=4#get-v1-financials-event_costs

get/v1/financials/event_costs

Request

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

Query parameters

filter_by_event_idinteger

Id of a specific event that you would like to retrieve costs for.

filter_by_event_start_date_greater_than_or_equal_tostring date

Only include costs for 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_event_start_date_smaller_than_or_equal_tostring date

Only include costs for 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_event_end_date_greater_than_or_equal_tostring date

Only include costs for 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_event_end_date_smaller_than_or_equal_tostring date

Only include costs for 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_start_date_categorystring

Only include the costs of 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 event date filters are ignored. To get the list of categories for your workspace, use /v1/references/event_start_date_categories. Any other value is rejected with an error.

$limitinteger

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

$offsetinteger

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

records_foundinteger
total_recordsinteger
has_moreboolean
list_typestring nullable

Changes

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