Users & Resources
Retrieve a Single Workspace User or Resource by ID #
|
Sample Object
|
Retrieves a single active user or Resource by its ID.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | String | Yes |
The user id of the active user or Resource in this workspace. Use the value from /v1/workspace_settings/users and treat it as text.
|
max length: 128
|
| $result_format | String | No |
By default, the response is a single object. Send
array to get it inside a one-item array.
|
Allowed values:
array |
Good to know
Retrieves one active user or Resource listed under Users & Permissions in your workspace. Use its id from the workspace member list. The response includes contact details, a profile photo link, workspace role, this workspace's Admin Notes, default Event Attendee Role, and the user's effective permissions and content restrictions. Default role id 1 means No Default Attendee Role; this setting is separate from a role already assigned for an Event. Custom role names come from your workspace, and a disabled custom role has state=unavailable. A Resource has its recorded contact email and permissions=null. The plan determines whether permissions can be customized; it does not remove existing effective permissions on Lite. Personal email, calendar and grid preferences, sign-in credentials, security settings and other workspaces are excluded. This read changes no member information and returns no edit revision.
curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users/info?id=11111111-2222-4333-8444-555555555555" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/workspace_settings/users/info?" + new URLSearchParams({ "id": "11111111-2222-4333-8444-555555555555" }), {
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/workspace_settings/users/info",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": "11111111-2222-4333-8444-555555555555"},
)
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/workspace_settings/users/info?id=11111111-2222-4333-8444-555555555555");
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/workspace_settings/users/info?id=11111111-2222-4333-8444-555555555555"))
.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/workspace_settings/users/info?id=11111111-2222-4333-8444-555555555555');
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/workspace_settings/users/info?id=11111111-2222-4333-8444-555555555555')
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/workspace_settings/users/info?id=11111111-2222-4333-8444-555555555555", 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
{
"id": "11111111-2222-4333-8444-555555555555",
"is_resource": false,
"first_name": "Illustrative",
"last_name": "Member",
"email": "member@example.invalid",
"organization": null,
"title": null,
"phone_number": null,
"profile_photo_url": "https://www.exhibitday.com/Images/Generic-User-Icon.png",
"workspace_role_id": 1,
"workspace_role": "Admin",
"workspace_member_joined_timestamp": null,
"permissions": {
"is_customization_available": true,
"grants": [
{
"id": 1,
"name": "Illustrative WorkspaceManagement_Can_Edit_Workspace_Settings",
"is_allowed": true
},
{
"id": 2,
"name": "Illustrative WorkspaceManagement_Can_Manage_Billing_And_Licensing",
"is_allowed": true
},
{
"id": 3,
"name": "Illustrative WorkspaceManagement_Can_Manage_Users_and_Permissions",
"is_allowed": true
},
{
"id": 4,
"name": "Illustrative EventManagement_Can_Add_Remove_Events",
"is_allowed": true
},
{
"id": 5,
"name": "Illustrative EventManagement_Can_Update_Event_Names_and_Dates_and_Basic_Info",
"is_allowed": true
},
{
"id": 6,
"name": "Illustrative EventManagement_Update_Event_Attendance_Status",
"is_allowed": true
},
{
"id": 8,
"name": "Illustrative EventManagement_Update_Event_Booth_Tab",
"is_allowed": true
},
{
"id": 9,
"name": "Illustrative EventManagement_Update_Event_Travel_Tab",
"is_allowed": true
},
{
"id": 10,
"name": "Illustrative EventManagement_Manage_Tasks_for_Any_Team_Member",
"is_allowed": true
},
{
"id": 11,
"name": "Illustrative EventManagement_Add_Update_Tasks_Only_For_Self",
"is_allowed": true
},
{
"id": 12,
"name": "Illustrative Budgeting_Can_Edit_Budgets",
"is_allowed": true
},
{
"id": 13,
"name": "Illustrative EventManagement_Has_Access_To_Booth_Invoices",
"is_allowed": true
},
{
"id": 14,
"name": "Illustrative EventManagement_Manage_Event_Attendees",
"is_allowed": true
},
{
"id": 15,
"name": "Illustrative EventManagement_Has_Access_To_Travel_Invoices",
"is_allowed": true
},
{
"id": 16,
"name": "Illustrative EventManagement_Has_Access_To_View_Event_Booth_Tab",
"is_allowed": true
},
{
"id": 17,
"name": "Illustrative EventManagement_Has_Access_To_View_Travel_Tab",
"is_allowed": true
},
{
"id": 18,
"name": "Illustrative EventManagement_Has_Access_To_View_Event_Tasks_And_Task_Board",
"is_allowed": true
},
{
"id": 19,
"name": "Illustrative Budgeting_Can_View_Budgets",
"is_allowed": true
},
{
"id": 20,
"name": "Illustrative EventManagement_Has_Access_To_View_Sponsorship_Tab",
"is_allowed": true
},
{
"id": 21,
"name": "Illustrative EventManagement_Has_Access_To_Update_Sponsorship_Tab",
"is_allowed": true
},
{
"id": 22,
"name": "Illustrative EventManagement_Has_Access_To_Sponsorship_Invoices",
"is_allowed": true
},
{
"id": 23,
"name": "Illustrative EventManagement_Has_Access_To_View_Other_Expenses_Tab",
"is_allowed": true
},
{
"id": 24,
"name": "Illustrative EventManagement_Has_Access_To_Update_Other_Expenses_Tab",
"is_allowed": true
},
{
"id": 25,
"name": "Illustrative EventManagement_Has_Access_To_Other_Expenses_Invoices",
"is_allowed": true
},
{
"id": 26,
"name": "Illustrative EventManagement_Has_Access_To_View_Shipment_Tab",
"is_allowed": true
},
{
"id": 27,
"name": "Illustrative EventManagement_Has_Access_To_Update_Shipment_Tab",
"is_allowed": true
},
{
"id": 28,
"name": "Illustrative EventManagement_Has_Access_To_Shipment_Invoices",
"is_allowed": true
},
{
"id": 29,
"name": "Illustrative EventManagement_Has_Access_To_Update_PlayBook_Tab",
"is_allowed": true
},
{
"id": 30,
"name": "Illustrative EventManagement_Has_Access_To_View_PlayBook_Tab",
"is_allowed": true
},
{
"id": 31,
"name": "Illustrative AssetManagement_Has_Access_To_View_Assets_Area",
"is_allowed": true
},
{
"id": 32,
"name": "Illustrative AssetManagement_Has_Access_To_Edit_Assets",
"is_allowed": true
},
{
"id": 33,
"name": "Illustrative EventManagement_Has_Access_To_Event_Assets_Tab",
"is_allowed": true
},
{
"id": 34,
"name": "Illustrative EventManagement_Has_Access_To_Update_Event_Assets_Tab",
"is_allowed": true
},
{
"id": 35,
"name": "Illustrative EventManagement_Has_Access_To_View_Event_Logs",
"is_allowed": true
},
{
"id": 38,
"name": "Illustrative EventManagement_Has_Access_To_Registration_Invoices",
"is_allowed": true
},
{
"id": 39,
"name": "Illustrative EventManagement_Has_Access_To_View_Giveaway_Tab",
"is_allowed": true
},
{
"id": 40,
"name": "Illustrative EventManagement_Has_Access_To_Update_Giveaway_Tab",
"is_allowed": true
},
{
"id": 41,
"name": "Illustrative EventManagement_Has_Access_To_Giveaway_Invoices",
"is_allowed": true
},
{
"id": 42,
"name": "Illustrative EventManagement_Has_Access_To_View_Special_Tab",
"is_allowed": true
},
{
"id": 43,
"name": "Illustrative EventManagement_Has_Access_To_Update_Special_Tab",
"is_allowed": true
},
{
"id": 44,
"name": "Illustrative AIChatBot_Access_To_AI_Bot",
"is_allowed": true
},
{
"id": 45,
"name": "Illustrative EventManagement_Has_Access_To_Update_Event_Settings_Tab",
"is_allowed": true
},
{
"id": 46,
"name": "Illustrative EventManagement_Has_Access_To_Playbook_Activity_Invoices",
"is_allowed": true
}
],
"content_restrictions": {
"only_my_events": false,
"only_my_travel": false,
"only_my_playbook": false,
"only_my_activity": false,
"only_accessible_related_items": false
}
},
"admin_notes": "Illustrative workspace-only Admin Notes",
"default_event_attendee_role": {
"id": 1,
"name": "No Default Attendee Role",
"state": "none"
}
}
{
"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": 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": "The current workspace member was not found.",
"error_code": "not_found",
"errors": [
"The current workspace member was not found."
],
"error_params": [
"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"
}
{
"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"
}
Retrieve Workspace Users and Resources #
|
Retrieves the active users and Resources in your workspace.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| $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 |
| filter_by_user_ids | String or JSON array | No |
Only return the matching active users or Resources. Send one ID or an array of IDs from this workspace's Users list. Omit or send [] for no ID filter. Each ID allows up to 128 characters. IDs are case-sensitive text, not numbers. No matches returns an empty list.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
|
| filter_by_is_resource | Boolean | No |
Pass true to return only Resources, or false to return only users who can sign in. Leave it out to include both.
|
|
| hydrate_permissions | Boolean | No |
Pass true to include each user's current effective permissions and all five content restrictions. The default is false, which leaves permissions=null for users. Resources always have permissions=null.
|
|
| $limit | Number | No |
The most matching records to return (a whole number of 1 or more). Leave it out to return all remaining matching records.
|
|
| $offset | Number | No |
How many matching records to skip (a whole number of 0 or more; 0 by default). Use this with $limit to read the next page.
|
|
| $result_sort | String | No |
Order workspace members by their opaque user IDs. Omit for ascending order; membership ID breaks ties. Unsupported values are refused. Use the values exactly as shown (lowercase).
|
Allowed values:
id_asc | id_desc |
Good to know
Returns the active users and Resources listed under Users & Permissions in your workspace. A Resource is a non-login contact or item, rather than a person who signs in; its email is its recorded contact email. Invitations and inactive or deactivated members are excluded. The response includes contact and workspace-role information. is_resource is true for a Resource and false for a user who can sign in. Pass hydrate_permissions=true to also include the effective permissions and content restrictions currently assigned to each user. Resources always have permissions=null. The ability to customize permissions is reported separately from the permissions a user actually has. Profile photo links use the normal ExhibitDay web page and its authentication; they are not API file-download links. Counts and pages can change if membership is edited while you are reading. Other workspaces and private account settings are not included.
curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/workspace_settings/users", {
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/workspace_settings/users",
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/workspace_settings/users");
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/workspace_settings/users"))
.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/workspace_settings/users');
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/workspace_settings/users')
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/workspace_settings/users", 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": 2,
"total_records": 2,
"has_more": false,
"list_type": "workspace_member",
"list_data": [
{
"id": "11111111-2222-4333-8444-555555555555",
"is_resource": false,
"first_name": "Illustrative",
"last_name": "Member",
"email": "member@example.invalid",
"organization": null,
"title": null,
"phone_number": null,
"profile_photo_url": "https://www.exhibitday.com/Images/Generic-User-Icon.png",
"workspace_role_id": 1,
"workspace_role": "Admin",
"workspace_member_joined_timestamp": null,
"permissions": null
},
{
"id": "66666666-7777-4888-8999-000000000000",
"is_resource": true,
"first_name": "Illustrative Resource",
"last_name": "",
"email": "resource@example.invalid",
"organization": "Illustrative supplier",
"title": "Display equipment",
"phone_number": "+1 202-555-0146",
"profile_photo_url": "https://www.exhibitday.com/Images/Associate-Profile-5.png",
"workspace_role_id": 4,
"workspace_role": "Resource",
"workspace_member_joined_timestamp": "2026-01-02T13:00:00Z",
"permissions": null
}
]
}
{
"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": 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": 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"
}
{
"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"
}
Retrieve a User's Event Involvements #
|
Retrieves the Events a user or Resource is involved in.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| user_id | String | Yes |
The user id of the active user or Resource in this workspace. Use the value from /v1/workspace_settings/users and treat it as text.
|
max length: 128
|
| filter_by_involvement | String | No |
Only return Events where the member has this involvement. Leave it out to match any involvement. Use the exact lower-case value.
|
Allowed values:
creator | attendee | travel_tag | playbook_tag | misc_expense_tag | task_assignee | task_contributor |
| filter_by_event_date_category | String | No |
Only include Events that have ended, or Events that are upcoming or in progress. Leave it out for both. This uses the full Event date range and your workspace time zone. Surrounding spaces and letter case are ignored. Sending JSON null is the same as leaving this filter out.
|
Allowed values:
past | upcoming |
| $limit | Number | No |
The most matching records to return (a whole number of 1 or more). Leave it out to return all remaining matching records.
|
|
| $offset | Number | No |
How many matching records to skip (a whole number of 0 or more; 0 by default). Use this with $limit to read the next page.
|
|
| $result_sort | String | No |
Sort by Event start date. If you omit this option, past Events sort newest first and other results sort oldest first. Event ID breaks ties in the same direction.
|
Allowed values:
start_date_asc | start_date_desc |
| $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 |
Good to know
Retrieves the Events a workspace user or Resource is involved in. Each Event appears once, with all of the member's involvements and the complete Event Lite summary.
Involvements
Each row contains involvements first, then event with the shared Event Lite fields. A member can have several involvements in the same Event.
The involvement filter selects matching Events. The returned involvements array still contains all of the member's real, visible involvements in each Event.
Attendee, travel, Playbook and Miscellaneous Expense or Credit involvements are left out when the Event hides that tab. An Event appears only when at least one involvement remains. Task involvements are included even when the Tasks tab is hidden.
- "creator": Created the Event.
- "attendee": Is listed as an Event attendee.
- "travel_tag": Is tagged in a Travel Reservation (types 1 through 8).
- "playbook_tag": Is tagged in a scheduled Playbook Activity.
- "misc_expense_tag": Is tagged in a Miscellaneous Expense or Credit.
- "task_assignee": Is assigned at least one Task for the Event.
- "task_contributor": Is tagged as a contributor on at least one Task for the Event.
Filtering and pages
Use user_id from the workspace user list. This reads saved associations; it does not sign in as that member or infer time spent.
The date and involvement filters are combined. Counts and paging apply to unique matching Events before their summaries are loaded. Omit $limit to return all remaining matches.
Past uses Events whose end date is before today in your workspace. Upcoming also includes Events in progress. Counts and paging come from the first matching set. Each selected Event is then read with its current details and visible involvements. Events that no longer match are left out, so a page may contain fewer rows than requested, or be empty, while total_records and has_more still describe the first matching set. A shortened final page can still report has_more=true; the next request can return no rows. Event dates or involvements can also change between pages; this is not a snapshot.
curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users/involvements?user_id=11111111-2222-4333-8444-555555555555" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/workspace_settings/users/involvements?" + new URLSearchParams({ "user_id": "11111111-2222-4333-8444-555555555555" }), {
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/workspace_settings/users/involvements",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"user_id": "11111111-2222-4333-8444-555555555555"},
)
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/workspace_settings/users/involvements?user_id=11111111-2222-4333-8444-555555555555");
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/workspace_settings/users/involvements?user_id=11111111-2222-4333-8444-555555555555"))
.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/workspace_settings/users/involvements?user_id=11111111-2222-4333-8444-555555555555');
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/workspace_settings/users/involvements?user_id=11111111-2222-4333-8444-555555555555')
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/workspace_settings/users/involvements?user_id=11111111-2222-4333-8444-555555555555", 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": 2,
"total_records": 2,
"has_more": false,
"list_type": "workspace_member_involvement",
"list_data": [
{
"involvements": [
"creator",
"attendee"
],
"event": {
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345",
"name": "Spring Trade Show",
"start_date": "2026-01-10",
"end_date": "2026-01-12",
"participation_type_id": 1,
"participation_type": "Going",
"format_id": 1,
"format": "In-Person",
"star_rating": 3,
"event_created_timestamp": "2019-11-05T14:00:00Z",
"event_last_update_timestamp": "2026-01-02T15:30:00Z",
"integration_metadata_field_1": "show-spring",
"integration_metadata_field_2": "",
"integration_metadata_field_3": "",
"integration_metadata_field_4": "",
"integration_metadata_field_5": ""
}
},
{
"involvements": [
"travel_tag",
"task_contributor"
],
"event": {
"id": 12346,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12346",
"name": "Regional Expo",
"start_date": "2026-02-10",
"end_date": "2026-02-12",
"participation_type_id": 1,
"participation_type": "Going",
"format_id": 1,
"format": "In-Person",
"star_rating": 4,
"event_created_timestamp": "2019-11-05T14:00:00Z",
"event_last_update_timestamp": "2026-01-02T15:30:00Z",
"integration_metadata_field_1": "show-regional",
"integration_metadata_field_2": "",
"integration_metadata_field_3": "",
"integration_metadata_field_4": "",
"integration_metadata_field_5": ""
}
}
]
}
{
"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": 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": "The current workspace member was not found.",
"error_code": "not_found",
"errors": [
"The current workspace member was not found."
],
"error_params": [
"user_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"
}
{
"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"
}
Retrieve a User's Workspace Logs #
|
Retrieves the workspace activity of a specific user.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| user_id | String | Yes |
The user id of the active workspace member whose authored entries you would like to retrieve. Treat it as text. Non-login Resources do not author this activity.
|
max length: 128
|
| $limit | Number | No |
The most entries to return (a whole number of 1 or more). Leave it out to return all remaining matching entries.
|
|
| $offset | Number | No |
How many matching entries to skip (a whole number of 0 or more; 0 by default). Use this with $limit to read the next page.
|
|
| $result_sort | String | No |
Sort entries newest first (the default) or oldest first. The full saved timestamp is used, with the entry ID breaking ties in the same direction. Responses display whole seconds. Unsupported values are refused. Use the values exactly as shown (lowercase).
|
Allowed values:
create_timestamp_desc (newest first) | create_timestamp_asc (oldest first) |
| $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 |
| filter_by_actor_user_id | String | No |
Only include entries written by the user with this id. Treat the id as text. Older entries can match a former user without exposing their account information.
|
|
| filter_by_log_entry_contains_text | String | No |
Only include entries containing this text, up to 3,000 characters. The characters are matched as sent; they are not converted from HTML or treated as wildcards.
|
|
| filter_by_create_timestamp_greater_than_or_equal_to | String | No |
Include entries created at or after this timestamp. Filters use the whole seconds shown in responses, so a fractional lower bound starts at the next whole second.
|
|
| filter_by_create_timestamp_smaller_than_or_equal_to | String | No |
Include entries created at or before this timestamp, including every entry in its displayed second. It can't be earlier than the lower bound.
|
|
| filter_by_event_id | Number | No |
Only include entries filed under this Event id in your workspace history.
|
|
| filter_by_event_tab_id | Number | No |
Only include entries filed under this Event tab ID. GET /v1/references/event_tabs lists your workspace's tabs; the Presentations tab is accepted only where your workspace has it.
|
Allowed values:
1 (Info) | 2 (Booth) | 3 (Staff) | 4 (Travel) | 5 (Assets) | 6 (Shipments) | 7 (Sponsorships) | 8 (Tasks) | 9 (Playbook) | 10 (Attachments) | 11 (Misc. Expenses & Credits) | 12 (Budget) | 13 (ROI) | 14 (Event Settings) | 16 (Binder) | 17 (Copy Event) | 19 (Logs) | 20 (Delete Event) | 21 (Giveaways) | 22 (Special Tab, shown under your workspace's name for it) |
| filter_by_context_type | String | No |
Only return entries associated with the selected context. Omit to include all contexts. Workspace means an entry with none of the other associations; an entry can belong to more than one other context. Unsupported values are refused. Values are case-insensitive.
|
Allowed values:
workspace | event | task | asset | storage_location |
What the history includes
Includes user-visible business history, including changes that do not appear in the Activity Feed. Internal diagnostics, impersonation activity, IP addresses, device details and security information are not included.
Each request reads the current history. Use these results to review activity; they are not a complete feed of record changes or deletions.
Filtering entries
When you supply several filters, an entry must match all of them. The total count and the returned page use those same filters.
Text searches match the characters you enter literally, without wildcard matching.
Reading dates and times
Returned timestamps are in UTC and show whole seconds. Sorting uses the full saved timestamp, then the entry ID to break ties; entries showing the same second can still have a distinct order.
Timestamp filters use the displayed whole-second precision. An upper bound includes all entries in that displayed second. A fractional lower bound starts at the next whole second.
A filter value with a time-zone offset is converted to US Eastern time for comparison. A value without an offset is interpreted as US Eastern time.
Reading the actor
actor_user_id is the ID of the user who made the change. actor_display_name is the name saved with the entry at that time; it does not change if the user is renamed later.
Entries recorded by the API have a null actor_user_id and show the label saved with them, such as API.
Choosing a user
Choose an active workspace member who can sign in, and supply their user_id as text. These are entries written by that person, rather than changes made to their account. Resources cannot write activity entries; selecting a Resource returns a validation error.
curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users/logs?user_id=11111111-2222-4333-8444-555555555555" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/workspace_settings/users/logs?" + new URLSearchParams({ "user_id": "11111111-2222-4333-8444-555555555555" }), {
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/workspace_settings/users/logs",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"user_id": "11111111-2222-4333-8444-555555555555"},
)
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/workspace_settings/users/logs?user_id=11111111-2222-4333-8444-555555555555");
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/workspace_settings/users/logs?user_id=11111111-2222-4333-8444-555555555555"))
.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/workspace_settings/users/logs?user_id=11111111-2222-4333-8444-555555555555');
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/workspace_settings/users/logs?user_id=11111111-2222-4333-8444-555555555555')
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/workspace_settings/users/logs?user_id=11111111-2222-4333-8444-555555555555", 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": "workspace_log",
"list_data": [
{
"id": 67890,
"log_entry_created_timestamp": "2026-01-02T08:04:05Z",
"actor_user_id": "11111111-2222-4333-8444-555555555555",
"actor_display_name": "Illustrative user",
"log_entry": "Illustrative user updated a workspace setting.",
"event_id": null,
"event_name": null,
"event_tab_id": 0,
"task_id": null,
"task_name": null,
"asset_id": null,
"asset_name": null,
"storage_location_id": null,
"storage_location_name": null
}
]
}
{
"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": 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": "Workspace member not found. Use a user ID from GET /v1/workspace_settings/users.",
"error_code": "not_found",
"errors": [
"Workspace member not found. Use a user ID from GET /v1/workspace_settings/users."
],
"error_params": [
"user_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"
}
{
"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"
}