Event Costs
Retrieve Event Costs #
|
Retrieves the costs recorded on your Events.
Parameters
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| filter_by_event_id | Number | No |
Return costs for this Event only. Omit to return costs for all Events that match the other filters.
|
|
| filter_by_event_start_date_greater_than_or_equal_to | Date | No |
Include Events that start on or after this date.
|
Use
YYYY-MM-DD. |
| filter_by_event_start_date_smaller_than_or_equal_to | Date | No |
Include Events that start on or before this date.
|
Use
YYYY-MM-DD. |
| filter_by_event_end_date_greater_than_or_equal_to | Date | No |
Include Events that end on or after this date.
|
Use
YYYY-MM-DD. |
| filter_by_event_end_date_smaller_than_or_equal_to | Date | No |
Include Events that end on or before this date.
|
Use
YYYY-MM-DD. |
| filter_by_event_start_date_category | String | No |
Choose
all for every Event, upcoming for Events that end today or later (including Events in progress), or past for Events that ended before today. A year selects Events that start in that calendar year. Today is based on your workspace's time zone. When you use this filter, the four date filters are ignored. Category values are case-insensitive and ignore surrounding spaces. See GET /v1/references/event_start_date_categories for your workspace's categories.
|
Allowed values:
all | upcoming | past | a year such as 2026 |
| filter_by_budget_year | Number | No |
Include Events that start in this fiscal year, using the same fiscal-year start month as Annual Budgets. Events must also match any start or end date filters you supply. Use either this filter or
filter_by_event_start_date_category. If the date bounds don't overlap, the response contains an empty list and a warning.
|
A four-digit year such as
2026. |
| $limit | Number | No |
The maximum number of cost records to return. Omit to return all remaining matches. Use
$offset for paging. total_records and the X-Total-Count header give the full count. has_more tells you whether more records are available.
|
A whole number of 1 or more.
|
| $offset | Number | No |
How many cost records to skip. For the next page, add the number of records you received to the current offset.
|
A whole number of 0 or more. Default
0. |
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
| $on_error_return_empty_result | Boolean | No |
Set to
true to return HTTP 200 with an empty list when an ID, date filter or paging value is invalid, or when the Event doesn't exist. Authentication, rate-limit and unexpected server errors keep their normal HTTP status.
|
Default: false.
|
Good to know
Retrieves the costs recorded on your Events, one record per cost. The list includes costs on hidden Event tabs. Filter by Event ID, Event dates, a start-date category, or a fiscal budget year.
Cost types
For Booth Services, cost_subtype gives the selected service type, including "Other" when that is the selected type. For Event Activities, it gives the activity type or category, such as "Presentation (Other)". It returns null for Booth Services without a type, General or unspecified Event Activities, and other cost types. The details field describes the individual item.
Code Samples
curl -X GET "https://api.exhibitday.com/v1/financials/event_costs" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/financials/event_costs", {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/financials/event_costs",
headers={"Authorization": "Bearer YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/financials/event_costs");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/financials/event_costs"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/financials/event_costs');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/financials/event_costs')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/financials/event_costs", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "event_cost",
"list_data": [
{
"id": 12345,
"cost_type_id": 6,
"cost_type": "Miscellaneous Expense/Credit",
"cost_subtype": null,
"details": "Sample expense",
"cost": {
"amount": 125.50,
"cost_center_breakdown": [
{
"cost_center_id": null,
"cost_center": "Not Specified",
"charge": 125.50
}
]
},
"amount": 125.50,
"amount_cost_center_breakdown": [
{
"cost_center_id": null,
"cost_center": "Not Specified",
"charge": 125.50
}
],
"payment_due_date": "",
"payment_status": {
"id": 0,
"name": "Not Specified"
},
"next_payment_due_date": "",
"payment_notes": "",
"event": {
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345",
"name": "Sample Event",
"start_date": "2026-12-19",
"end_date": "2026-12-21",
"participation_type_id": 1,
"participation_type": "Committed",
"format_id": 1,
"format": "In-Person",
"event_created_timestamp": "2026-11-19T17:00:00Z",
"event_last_update_timestamp": "2026-11-19T17:00:00Z"
}
}
]
}
Note: IDs are illustrative; use IDs from your workspace.
Note: There is no response body. Keep using your cached response.
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Invalid value for parameter filter_by_budget_year. Use a whole budget year from 1754 through 9999.",
"error_code": "invalid_request",
"errors": [
"Invalid value for parameter filter_by_budget_year. Use a whole budget year from 1754 through 9999."
],
"error_params": [
"filter_by_budget_year"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Do not combine filter_by_budget_year with filter_by_event_start_date_category. Choose the fiscal budget year or the existing Event date category.",
"error_code": "invalid_request",
"errors": [
"Do not combine filter_by_budget_year with filter_by_event_start_date_category. Choose the fiscal budget year or the existing Event date category."
],
"error_params": [
"filter_by_event_start_date_category",
"filter_by_budget_year"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Event not found. Invalid Event ID: 12345.",
"error_code": "not_found",
"errors": [
"Event not found. Invalid Event ID: 12345."
],
"error_params": [
"filter_by_event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Note: Use the request_id from your own response when contacting support.
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}