References
Event Participation Types #
|
Sample Object
{
"id": 1,
"name": "Committed"
} |
Returns a list of available event participation types (i.e., Committed, Considering, Not Going, etc.) which can be used when creating or updating an event. If you have created custom event participation types in your ExhibitDay workspace, they will also get returned.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
|
| $result_format | String | No |
Pass in "array" to get the results as a plain JSON array (without records_found and list_type).
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/event_participation_types" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/event_participation_types", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/event_participation_types",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/event_participation_types");
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/references/event_participation_types"))
.header("api_key", "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/references/event_participation_types');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/event_participation_types')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/event_participation_types", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/event_participation_types - HTTP 200
{
"records_found": 3,
"list_type": "event_participation_type",
"list_data": [
{
"id": 1,
"name": "Committed"
},
{
"id": 2,
"name": "Considering"
},
{
"id": 3,
"name": "Not Going"
}
]
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Event Custom Fields #
|
Sample Object
{
"field_name": "custom_67890",
"event_tab": "Info",
"field_type": "Text (Single-line)",
"field_label": "Integration status",
"is_hidden": false
} |
Returns a list of available custom event fields (custom fields that have been added to events) in your ExhibitDay workspace. The /v1/events/info response includes the event's custom_fields collection. For the /v1/events list, pass hydrate_custom_fields=true to include that collection; the shorter $return_event_lites representation does not include it. The list also contains layout items (labels and dividers) whose field_type is empty; they hold no value.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/event_custom_fields" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/event_custom_fields", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/event_custom_fields",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/event_custom_fields");
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/references/event_custom_fields"))
.header("api_key", "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/references/event_custom_fields');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/event_custom_fields')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/event_custom_fields", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/event_custom_fields - HTTP 200
{
"records_found": 1,
"list_type": "event_custom_field",
"list_data": [
{
"field_name": "custom_67890",
"event_tab": "Info",
"field_type": "Text (Single-line)",
"field_label": "Integration status",
"is_hidden": false
}
]
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Cost Centers #
|
Sample Object
{
"id": 12345,
"name": "Marketing"
} |
Returns a list of cost centers that are configured in your ExhibitDay workspace.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/cost_centers" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/cost_centers", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/cost_centers",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/cost_centers");
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/references/cost_centers"))
.header("api_key", "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/references/cost_centers');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/cost_centers')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/cost_centers", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/cost_centers - HTTP 200
[
{
"id": 12345,
"name": "Marketing"
}
]
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Event Cost Types #
|
Sample Object
{
"id": 1,
"name": "Booth Reservation"
} |
Returns a list of event cost types. Type 9 is Event Activities and represents costs recorded under Playbook activities.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/event_cost_types" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/event_cost_types", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/event_cost_types",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/event_cost_types");
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/references/event_cost_types"))
.header("api_key", "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/references/event_cost_types');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/event_cost_types')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/event_cost_types", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/event_cost_types - HTTP 200
{
"records_found": 9,
"list_type": "event_cost_type",
"list_data": [
{
"id": 1,
"name": "Booth Reservation"
},
{
"id": 2,
"name": "Booth Service"
},
{
"id": 3,
"name": "Travel"
},
{
"id": 4,
"name": "Shipment"
},
{
"id": 5,
"name": "Sponsorship"
},
{
"id": 6,
"name": "Miscellaneous Expense/Credit"
},
{
"id": 7,
"name": "Attendee Registration"
},
{
"id": 8,
"name": "Giveaway"
},
{
"id": 9,
"name": "Event Activities"
}
]
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Payment Statuses #
|
Sample Object
{
"id": 0,
"name": "Not Specified"
} |
Returns a list of Payment Status types.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/payment_statuses" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/payment_statuses", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/payment_statuses",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/payment_statuses");
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/references/payment_statuses"))
.header("api_key", "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/references/payment_statuses');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/payment_statuses')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/payment_statuses", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/payment_statuses - HTTP 200
{
"records_found": 4,
"list_type": "payment_status",
"list_data": [
{
"id": 0,
"name": "Not Specified"
},
{
"id": 1,
"name": "Paid in Full"
},
{
"id": 2,
"name": "Partially Paid"
},
{
"id": 3,
"name": "Not Paid Yet"
}
]
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Event Tags #
|
Sample Object
[ "Sample tag" ] |
Returns a list of all distinct event tags in your workspace.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
|
| $result_format | String | No |
Pass in "array" to get the results as a plain JSON array (without records_found and list_type).
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/event_tags" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/event_tags", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/event_tags",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/event_tags");
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/references/event_tags"))
.header("api_key", "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/references/event_tags');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/event_tags')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/event_tags", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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)
}
Users and Resources #
|
Sample Object
{
"id": "11111111-2222-4333-8444-555555555555",
"type": "User",
"role": "Admin",
"can_have_tasks_assigned": true,
"display_name": "Jane Smith",
"last_name": "Smith",
"first_name": "Jane",
"email": "jane@example.invalid",
"phone_number": "",
"organization": "",
"title": "",
"admin_notes": ""
} |
Returns a list of users and resources in your ExhibitDay workspace.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
|
| filter_by_can_have_tasks_assigned | Boolean | No |
default: false
|
Pass in true to only include the users who can have tasks assigned to them (resources, and users who can't be assigned tasks, are left out).
|
| $result_format | String | No |
Pass in "array" to get the results as a plain JSON array (without records_found and list_type).
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/users_and_resources" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/users_and_resources", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/users_and_resources",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/users_and_resources");
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/references/users_and_resources"))
.header("api_key", "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/references/users_and_resources');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/users_and_resources')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/users_and_resources", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/users_and_resources - HTTP 200
{
"records_found": 1,
"list_type": "user",
"list_data": [
{
"id": "11111111-2222-4333-8444-555555555555",
"type": "User",
"role": "Admin",
"can_have_tasks_assigned": true,
"display_name": "Jane Smith",
"last_name": "Smith",
"first_name": "Jane",
"email": "jane@example.invalid",
"phone_number": "",
"organization": "",
"title": "",
"admin_notes": ""
}
]
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Workspace Info #
|
Sample Object
{
"id": 98765,
"name": "Sample Workspace",
"num_events": 1,
"num_tasks": 1,
"num_assets": 1
} |
Returns basic information about the ExhibitDay workspace that your API key belongs to: its id and name, and the number of events, tasks and assets in it. This is a quick way to check that an API key works and which workspace it belongs to.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/workspace_info" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/workspace_info", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/workspace_info",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/workspace_info");
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/references/workspace_info"))
.header("api_key", "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/references/workspace_info');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/workspace_info')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/workspace_info", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/workspace_info - HTTP 200
{
"id": 98765,
"name": "Sample Workspace",
"num_events": 1,
"num_tasks": 1,
"num_assets": 1
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Event Start Date Categories #
|
Sample Object
[
{
"id": "all",
"value": "All Events"
},
{
"id": "upcoming",
"value": "Upcoming Events"
},
{
"id": "past",
"value": "Past Events"
},
{
"id": "2026",
"value": "2026 Events"
}
] |
Returns the categories you can pass in for the filter_by_event_start_date_category parameter of the Retrieve Events and Retrieve Event Costs methods, as id/value pairs: all, upcoming, past, and one category for every year in which your workspace has events (most recent year first). Pass in the id.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/event_start_date_categories" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/event_start_date_categories", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/event_start_date_categories",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/event_start_date_categories");
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/references/event_start_date_categories"))
.header("api_key", "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/references/event_start_date_categories');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/event_start_date_categories')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/event_start_date_categories", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/event_start_date_categories - HTTP 200
[
{
"id": "all",
"value": "All Events"
},
{
"id": "upcoming",
"value": "Upcoming Events"
},
{
"id": "past",
"value": "Past Events"
},
{
"id": "2026",
"value": "2026 Events"
}
]
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Filterable Event Custom Fields #
|
Sample Object
[
{
"id": "67890",
"value": "Info Tab > Integration status"
}
] |
Returns the event custom fields that you can filter events by (Custom Text fields and Custom Dropdown fields), as id/value pairs. The value names the field and its event tab. Pass in an id as the filter_by_custom_field_value_setting_id parameter of the Retrieve Events method.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/filterable_event_custom_fields" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/filterable_event_custom_fields", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/filterable_event_custom_fields",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/filterable_event_custom_fields");
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/references/filterable_event_custom_fields"))
.header("api_key", "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/references/filterable_event_custom_fields');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/filterable_event_custom_fields')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/filterable_event_custom_fields", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/filterable_event_custom_fields - HTTP 200
[
{
"id": "67890",
"value": "Info Tab > Integration status"
}
]
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Budget Years #
|
Sample Object
[
{
"id": "2026",
"value": "2026"
}
] |
Returns the years for which your workspace has a yearly budget, as id/value pairs (most recent year first).
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/references/budget_years" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/references/budget_years", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/references/budget_years",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/references/budget_years");
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/references/budget_years"))
.header("api_key", "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/references/budget_years');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: 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/references/budget_years')
request = Net::HTTP::Get.new(uri)
request['api_key'] = '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/references/budget_years", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "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 HTTP response body (JSON)
GET /v1/references/budget_years - HTTP 200
[
{
"id": "2026",
"value": "2026"
}
]
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).