# Getting Started with the ExhibitDay API

This is the Markdown copy of https://api.exhibitday.com/ for AI tools. Code examples are in curl, JavaScript, Python and C#; the help page shows all 8 languages, and https://api.exhibitday.com/llms-full.txt has the complete reference in one file. Index of all pages: https://api.exhibitday.com/llms.txt

Key facts:

- Base URL: https://api.exhibitday.com/v1
- Authentication: send the workspace API key as `Authorization: Bearer YOUR_API_KEY`. `X-API-Key` and the legacy `api_key` parameter still work. Find the key under Workspace Settings > API & Integrations > API Access.
- Rate limit: 50 calls per second per workspace by default. Workspace rate checks return `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` (seconds) headers; a separate IP rate check can refuse a request before those headers are added. A 429 response carries `Retry-After` (seconds). Use the returned limit and retry headers rather than assuming a fixed allowance.
- Error responses are JSON with `status_code`, `status`, `message`, `errors`, a stable `error_code`, `error_params` (the parameters the errors refer to), `request_id` (also in the X-Request-Id header) and, when applicable, `warnings`. Successful object responses also include warnings for unknown, unsupported, ignored or defaulted parameters, and for empty values sent on an update. On a create, an empty value means no value and gets no warning. Warnings can also report attachments that could not be copied to an inventory return.
- Successful warnings: arrays and 304 responses retain their shape and expose a JSON-array `X-API-Warnings` header. `X-API-Warnings-Count` gives the full count; `X-API-Warnings-Truncated: true` means the 6000-character ASCII header limit was reached. Request the default object format for the full warning list. Invalid values that would be stored return 400.
- Lists: use `$limit` and `$offset` on endpoints that support paging (responses include `total_records` and `has_more`). Use `filter_by_last_update_timestamp_greater_than_or_equal_to` where supported to retrieve changes; upsert every returned record by ID, including records at the inclusive timestamp boundary.
- Retries: send an `Idempotency-Key` header with a create (POST). Successful responses are retained for 24 hours; retry the same request with the same byte-identical, case-sensitive key during that period to reuse the saved response. Follow the documented 409 handling when a request is still running or its outcome is unknown. DELETE has no idempotency replay contract; after an uncertain response, retrieve the record first and treat a later `not_found` as already absent. Successful API GET responses that return JSON include an `ETag` for `If-None-Match`; file downloads do not.
- HTTP methods: send actual documented verbs. Method tunneling is refused with 400 `invalid_request` on every endpoint: `X-HTTP-Method-Override` as a header, a form field or a query-string parameter, and form/query `_method` (a request with no API key in a header, the query string or a form field gets 401 first; a request with a JSON body gets 400, because its key may be inside the body).
- Updates: on PATCH requests, omit fields you want to keep. Empty or whitespace-only update values are ignored with a warning. A JSON null or the text `null` clears or resets a supported field; fields that cannot be cleared return an error. The legacy `$ignore_params_with_empty_values=true` option drops empty values and JSON nulls before updates; the text `null` still requests a clear. Related fields can also change to keep the record consistent; see the endpoint's field rules. To update only if none of the fields that PATCH can change has changed since you read the record, read it with `$include_record_revision=true` and send the returned `record_revision` as `expected_revision` (the help page lists what each revision covers; a change undone in between does not count); a 409 `record_changed` then means nothing was saved: read it again and decide whether to send your change again. After no response or a 5xx on a PATCH, read the record before sending it again: it may already have been saved.

Use this API to programmatically read and update data in your ExhibitDay workspace. The API helps you automate the exchange of information between ExhibitDay and your internal systems or third-party software.

To set up integrations, you'll need a working knowledge of REST APIs.

New to these terms? See Key terms at the bottom of this page.

## 1. Get your API key

In ExhibitDay, go to **Workspace Settings → API & Integrations → API Access** and copy your workspace's API key. Keep it private. Anyone with the key can read and change your workspace's data through the API.

## 2. Make your first request

To retrieve the list of Events in your workspace, replace `YOUR_API_KEY` with your key and run this command in a terminal.

```bash
curl -X GET "https://api.exhibitday.com/v1/events" -H "Authorization: Bearer YOUR_API_KEY"
```

## 3. Read the response

A successful request returns HTTP `200`. The `list_data` array contains the Events returned by your request. If your workspace has no Events, the request still succeeds and `list_data` is an empty array (`[]`).

Got `401`? Check that you replaced `YOUR_API_KEY` with the key from your workspace, that the header reads `Authorization: Bearer` followed by a space and your key, and that API access is enabled for your workspace.

## Authentication

Send your API key with every request. We recommend the `Authorization` header:

```
Authorization: Bearer YOUR_API_KEY
```

You can also send the key in an `X-API-Key` header:

```
X-API-Key: YOUR_API_KEY
```

**Older integrations.** Integrations built before November 2026 often send the key as an `api_key` parameter, for example the header `api_key: YOUR_API_KEY`. That still works and you don't need to change it. You can also send `api_key` in the query string, form data or JSON body. Avoid putting the key in the query string, because web addresses are often saved in server logs and browser history.

If you use `Authorization: Bearer` or `X-API-Key` and also send the key another way, all copies must be the same key. Different keys return `400` (`invalid_request`) and nothing is changed.

If your key is exposed, generate a new one under **Workspace Settings → API & Integrations → API Access**. Integrations that use the old key stop working until they're updated with the new one.

## Sending parameters

For a GET request, put filters and paging options in the URL's query string. For a create or update, send field values in a JSON body with the `Content-Type: application/json` header. For a delete, put the record's `id` in the query string. Send your API key in a header, as described in [Authentication](#authentication).

## Parameter formats, repeated values, and size limits

- **Where to send a value.** The API accepts parameters in headers, the query string, or a JSON body. For example, send the fields you want to update in a JSON body. You can send a parameter more than once if every copy has the same value. If the copies differ, the API returns `400` (`invalid_request`) and nothing is changed.
- **JSON values.** Most fields accept a single value. Use an array or object only when the endpoint specifies that format. Write a JSON number as `12345`. If you need leading zeros, use a quoted string such as `"012345"` where the parameter accepts it.
- **Lists.** A parameter that takes a list accepts a real JSON array, for example `["user-id","other-user-id"]`, or the same list written as JSON text inside a string, for example `"[\"user-id\"]"`. In a query string or form, send the list as JSON text. Where a list holds objects, you can send one object instead of a list of one. A list of IDs, such as `tagged_user_ids` or `task_ids`, also takes one ID on its own, for example `"user-id"` or `12345`, as a list of one. On an update, `[]` or `null` removes every item from a list that can be cleared. One exception: Event tags (`tags`) also take plain comma-separated text, so text sent inside a string is read as tag names; send a real JSON array for the list form.
- **Event tab options.** Options that choose Event tabs use one naming rule: the tab name, and the tab name followed by `_costs` for its cost details. For example, `POST /v1/events/copy` takes `copy_shipments` and `copy_shipments_costs`, and `GET /v1/events/binder/export` takes `include_shipments` and `include_shipments_costs`. The one exception is objectives: the binder shows them in two sections, `include_roi` and `include_roo`, and copy takes `copy_objectives`.
- **Request size.** JSON bodies can be up to 10 MB. For a long filter value, use a JSON body. Keep encoded URLs under roughly 16,000 characters. The server's exact limit can vary. If it rejects a URL before it reaches the API, you may see a plain `414` or `400` response and no entry in the API logs. File uploads use multipart form data and have their own endpoint-specific limits.
- **HTTP method.** Send the method shown on the endpoint. Method overrides using `X-HTTP-Method-Override` or `_method` are rejected with `400` (`invalid_request`) on every endpoint, and nothing is changed. A request with no API key in a header, the query string or a form field gets `401` first; a request with a JSON body is refused with `400`, because its key may be inside the body.

## Updating or clearing a field

Include the required identifiers with each PATCH request. For editable fields, choose the option that matches what you want to do.

| To do this | Send this |
| --- | --- |
| Keep a value | Omit the field. Its saved value is normally preserved. |
| Change a value | Send the field with its new value. |
| Clear a value | Send JSON `null` or the string `"null"` if the field supports clearing. The endpoint explains whether that empties the field, removes a value, or restores a default. |

For example, this request clears the due date of Task `12345`. The empty string for `details` keeps the saved details and produces a warning.

```bash
curl -X PATCH "https://api.exhibitday.com/v1/tasks" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"due_date\":null,\"details\":\"\"}"
```

## Example response and empty-field rules

When the due date changes, the response identifies the updated field and includes a warning for `details`.

```json
{
    "status_code": 200,
    "status": "OK",
    "message": "Task Update Successful. Task properties that were changed: due_date",
    "errors": [],
    "warnings": [
        "details was empty, so it was left unchanged."
    ]
}
```

On an update, a blank input usually keeps the saved value and adds a warning. On a create, a blank input simply means no value, and no warning is added. Some changes clear other saved values that no longer apply, for example a status change that removes notes kept only for another status. The response then includes a warning naming each cleared field. A Task comment requires text, so sending a blank comment can return an error. On updates that support `$ignore_params_with_empty_values=true`, empty values and JSON `null` are skipped without a warning. To clear a supported field with that option enabled, send the string `"null"`.

Changing one field can affect another. For example, moving a Task to a different Event resets its section unless you also supply a valid section for the new Event. Check the endpoint for rules about related fields. When creating a record, JSON `null` doesn't always mean the same as leaving a field out. Some fields treat it as omitted, and others refuse it. The field's help describes any special rules. Leave out fields you don't want to set.

Deleting something that no longer exists, such as a record, a file or an invoice that was already removed, returns `404` Not Found with a message that says what is missing.

## Costs and payments

Enter a cost when adding or updating its record, such as a Booth Service or Shipment. You can provide a single amount or divide it between cost centers. Payment details and Invoice Attachments are handled separately.

See [Record Costs and Split Them Across Cost Centers](https://api.exhibitday.com/Help/V1?guide=entering-costs) for examples and a walkthrough of changing saved costs.

## Lookup lists

Most lookups under `/v1/references` return an object with `records_found`, `list_type` and `list_data`, a list of choices with an `id` and a `name`. Send `$result_format=array` to get just the list. Every new lookup uses this shape. These older lookups keep the shape they have always had:

| Lookup | Default response | Common shape |
| --- | --- | --- |
| `GET /v1/references/cost_centers` | A JSON array of cost centers | Send `$result_format=object` |
| `GET /v1/references/budget_years` | A JSON array of `{"id": "2035", "value": "2035"}` items | Send `$result_format=object` (the items keep their `id` and `value`) |
| `GET /v1/references/filterable_event_custom_fields` | A JSON array of `id`/`value` items | Send `$result_format=object` (the items keep their `id` and `value`) |
| `GET /v1/references/event_start_date_categories` | A JSON array of `id`/`value` items | Send `$result_format=object` (the items keep their `id` and `value`) |
| `GET /v1/references/event_tags` | The common wrapper, with tag names (text) in `list_data` | Already the default |

## Paging through results

On list endpoints that support paging, `$limit` sets how many records to return and `$offset` sets how many matches to skip. This example requests the first 100 Events. To get the next page, change the offset to `100`.

```bash
curl -X GET "https://api.exhibitday.com/v1/events?%24limit=100&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"
```

In the standard Events list response, `records_found` is the number of Events on this page, `total_records` counts all matching Events, and `has_more` tells you whether another page follows. The `X-Total-Count` header also gives the total.

## Understanding responses

For an API error, use `error_code` to decide what to do next. Check `error_params` for the affected fields, and include `request_id` when contacting support. The request ID is also available in the `X-Request-Id` header. If your integration encounters an unfamiliar error code, handle it by HTTP status.

| HTTP status | What to do |
| --- | --- |
| 200 OK | The request succeeded. Check the response for data and any warnings. |
| 304 Not Modified | Use your saved copy. Your conditional GET matched the server's current response. |
| 400 Bad Request | Read the error to find out which input needs correcting or why the operation is unavailable for this record. |
| 401 Unauthorized | Check your API key, how you're sending it (see [Authentication](#authentication)), and your workspace's API access setting. |
| 404 Not Found | For `not_found`, check the record ID. For `unknown_endpoint`, check the URL and HTTP method. |
| 409 Conflict | Check `error_code` before retrying. For `record_changed`, retrieve the record and review its current values first. |
| 429 Too Many Requests | Wait the number of seconds in the `Retry-After` header before retrying. |
| 500 Internal Server Error | If you were saving a change, check whether it succeeded before retrying. Include the request ID if you contact support. |

See [Handle Errors and Retry Failed Requests](https://api.exhibitday.com/Help/V1?guide=errors-and-retries) for recovery steps.

## Error codes and an example response

`error_params` is an empty array when the API cannot identify a specific parameter.

```json
{
    "status_code": 400,
    "status": "Bad Request",
    "message": "Invalid Event ID in event_id. Use a valid Event ID, or omit this filter.",
    "error_code": "invalid_request",
    "errors": [
        "Invalid Event ID in event_id. Use a valid Event ID, or omit this filter."
    ],
    "error_params": [
        "event_id"
    ],
    "request_id": "3f2c9a7e4b1d4c8e9f0a1b2c3d4e5f60"
}
```

| Error code | HTTP status | Meaning |
| --- | --- | --- |
| `invalid_request` | 400 | A parameter is missing or has an invalid value (error_params names it when the API can tell). This includes any parameter sent more than once with different values (matching copies are accepted), and an expected_revision that is blank, null, malformed or sent to an operation that does not support it. |
| `malformed_json` | 400 | The request body is not valid JSON. The error message says what the parser found and where (line and position), so you can correct the JSON and send it again. |
| `not_allowed` | 400 | The change is not allowed for that record in ExhibitDay (e.g., the event's tasks or its deletion are locked, or its Misc. Expenses & Credits tab is hidden). |
| `idempotency_key_reused` | 400 | The Idempotency-Key was already used with a different request. Use a new key for a new request. |
| `missing_api_key` | 401 | 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. |
| `invalid_api_key` | 401 | 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. |
| `api_access_disabled` | 401 | 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'. |
| `not_found` | 404 | No record with that id exists in your workspace. |
| `unknown_endpoint` | 404 | The URL or HTTP method is not part of the API. |
| `idempotency_key_in_use` | 409 | A request with the same Idempotency-Key is still being processed. Retry after a moment. |
| `idempotency_key_indeterminate` | 409 | An earlier request did not finish with a confirmed outcome, or its saved response can no longer be returned safely. This retry was not run. Look for the existing record with a GET before deciding whether another create is needed; use a new Idempotency-Key only after checking. |
| `record_changed` | 409 | The record changed while it was being saved or read, or it changed since the read whose record_revision you sent as expected_revision. Nothing was changed by this request. Retrieve its current values, review them and retry only if your change still applies. |
| `file_copy_pending` | 409 | This file is still being copied. Try again in a few minutes. |
| `inventory_busy` | 409 | Another inventory operation is still finishing. This request did not start its event changes; wait briefly, retrieve the event's current state and retry deletion if still needed. |
| `attachment_preservation_failed` | 409 | Required reservation attachment copies could not be created. The event and its inventory were not changed. Check the reservation attachments in ExhibitDay before retrying deletion. |
| `rate_limited` | 429 | Too many requests. Wait the number of seconds in the Retry-After header, then retry. |
| `internal_error` | 500 | An unexpected error occurred. Please try again later. |

## Warnings and rate-limit headers

Check `warnings` in the default object response for inputs the API skipped or defaulted. For example, an unrecognized parameter name produces a warning. An invalid value for a field the API would save returns HTTP `400`.

Responses can also report warnings in `X-API-Warnings`, including error responses, array responses and bodyless `304` responses. This ASCII-escaped JSON array is limited to 6,000 characters. `X-API-Warnings-Count` gives the full number of warnings. If `X-API-Warnings-Truncated` is `true`, use the default object format to read the complete list.

The default workspace limit is 50 calls per second. `X-RateLimit-Limit` gives your effective limit, `X-RateLimit-Remaining` tells you how many calls are left, and `X-RateLimit-Reset` gives the seconds until the window resets. A request limited earlier by IP may lack the workspace headers. On `429`, follow `Retry-After`.

## How empty fields appear in responses

Unset text fields usually return `""`. Dates, related objects, and related IDs usually return `null`. Unset numbers usually return `0`, and empty lists return `[]`. Some fields use older formats:

- On Events, unset `booth_date_reserved` and `booth_reserve_by_date` return `""`.
- In `/v1/financials/event_costs`, unset `payment_due_date`, `next_payment_due_date`, and `payment_notes` return `""`. A missing `cost_subtype` returns `null`.
- On a miscellaneous expense or credit, empty `payment_notes` returns `null` and empty `notes` returns `""`.
- With `$return_task_lites`, unset `assignee_user_id` and `task_completed_by_user_id` return `""`.

## Changes made through the API or Zapier

When a record is created, completed, or commented on through the API or Zapier, its person field (`event_created_by`, `task_created_by`, `task_completed_by`, or `commenter`) has an `id` of `null`, because no workspace user made the change. Use `display_name` to identify it: `"ExhibitDay API"` for the API and `"ExhibitDay API (Zapier)"` for Zapier. Its `first_name` is `"ExhibitDay"`, its `last_name` is `"API"`, and its `email`, `type`, and `workspace_role` are `null`.

With `$return_task_lites`, `task_created_by_user_id` and `task_completed_by_user_id` return the integration's name as text, such as `"ExhibitDay API"` or `"Zapier"`, instead of a user ID. Activity log entries recorded by the API have a `null` `actor_user_id`. Use `actor_display_name` to identify them.

## Retrying requests and checking for changes

## Retry a create request without creating a duplicate

For a create endpoint that supports `Idempotency-Key`, send a unique key with the first POST. If you need to retry that create, send the same key, URL, body, and parameter headers exactly as before. Once the API has stored a successful response, an identical retry within 24 hours returns that response with `Idempotent-Replayed: true`.

- `idempotency_key_in_use`: the first request is still running. Wait briefly and retry with the same key.
- If you receive `idempotency_key_indeterminate`, check whether the first request created the record. Use a new key only after confirming the record was not created.
- `idempotency_key_reused`: the key was used with a different request. Give each new create request its own key.

For a DELETE with an uncertain outcome, retrieve the record before retrying. A `404` with `not_found` means the record is already absent.

## Check whether a saved GET response is still current

Save the `ETag` from a successful data request (GET responses that return JSON include one; file downloads do not). The next time you GET the same URL, send that value in the `If-None-Match` header. If the response still matches, the API returns `304 Not Modified` with no body. You can reuse your saved response.

## Avoid overwriting someone else's changes

1. Retrieve the record using the GET endpoint listed for the operation below. Include `$include_record_revision=true`.
2. In your update or delete request, set `expected_revision` to the exact `record_revision` value returned by GET. Omit it to skip the revision check.

If any covered value differs from the one you read, the API saves nothing and returns `409` (`record_changed`). Retrieve the record again, review the current values, and decide whether to retry. A value that changed and was later changed back still matches. A successful conditional update returns the current revision.

If you lose the response to an update, read the record before retrying. If a GET cannot return a revision because the record keeps changing, repeat the GET. A blank, null, malformed, or conflicting `expected_revision` returns `400` (`invalid_request`), as does sending it to an operation that does not support it.

Each operation lists the values its revision covers. An edit to a covered field can cause a conflict even if your request omits that field.

- [`PATCH /v1/events`](https://api.exhibitday.com/Help/V1?epf=1#patch-v1-events) — get the revision from [`GET /v1/events/info`](https://api.exhibitday.com/Help/V1?epf=1#get-v1-events-info). Covered: every field this PATCH can change, tags, custom field values, and the readable Booth Reservation payment fields and complete saved cost allocations. A revision obtained without access to Booth financials can still protect other Event changes; financial values are masked, and a visibility change requires a fresh revision. Not covered: custom field labels or settings, derived venue location fields, Booth reservation status and reservation dates set in ExhibitDay, other cost categories or total_sum_event_costs, current cost center names, invoices, files, tasks, task_sections or misc_expenses_credits. Read a fresh Event revision before using the new Booth cost or payment fields.
- [`PATCH /v1/events/misc_expenses_credits`](https://api.exhibitday.com/Help/V1?epf=100#patch-v1-events-misc_expenses_credits) — get the revision from [`GET /v1/events/misc_expenses_credits/info`](https://api.exhibitday.com/Help/V1?epf=100#get-v1-events-misc_expenses_credits-info). Covered: every field this PATCH can change (the amount together with its cost-center allocation), and the expected credit date, credit status and credit notes set in ExhibitDay.
- [`PATCH /v1/tasks`](https://api.exhibitday.com/Help/V1?epf=2#patch-v1-tasks) — get the revision from [`GET /v1/tasks/info`](https://api.exhibitday.com/Help/V1?epf=2#get-v1-tasks-info). Covered: every field this PATCH can change, and the task's links to related items in ExhibitDay. Not covered: display_rank (it changes when tasks are reordered), task_completed_by and task_completed_timestamp, and the comments in the response.
- [`PATCH /v1/tasks/comments`](https://api.exhibitday.com/Help/V1?epf=2&amp;topic=comments#patch-v1-tasks-comments) — get the revision from [`GET /v1/tasks/comments/info`](https://api.exhibitday.com/Help/V1?epf=2&amp;topic=comments#get-v1-tasks-comments-info). Covered: the comment's text, including formatting changed in ExhibitDay. Not covered: event_id (it is the event of the comment's task, which can move to another event).
- [`DELETE /v1/workspace_settings/users/invitations`](https://api.exhibitday.com/Help/V1?epf=6&amp;topic=user-invitations#delete-v1-workspace_settings-users-invitations) — get the revision from [`GET /v1/workspace_settings/users/invitations/info`](https://api.exhibitday.com/Help/V1?epf=6&amp;topic=user-invitations#get-v1-workspace_settings-users-invitations-info). Covered: this invitation, its recipient, intended role, complete saved permission denials and content restrictions, current status, API-origin protocol and saved automatic-email preference. Not covered: invitation links or proof digests, real-inviter attribution or creation, acceptance, send and reminder timestamps. The token protects optional revocation, grants no permission, and is not an email verification link.
- [`POST /v1/workspace_settings/users/invitations/resend`](https://api.exhibitday.com/Help/V1?epf=6&amp;topic=user-invitations#post-v1-workspace_settings-users-invitations-resend) — get the revision from [`GET /v1/workspace_settings/users/invitations/info`](https://api.exhibitday.com/Help/V1?epf=6&amp;topic=user-invitations#get-v1-workspace_settings-users-invitations-info). Covered: this invitation, its recipient, intended role, complete saved permission denials and content restrictions, current status, API-origin protocol and saved automatic-email preference. Not covered: invitation links or proof digests, real-inviter attribution or creation, acceptance, send and reminder timestamps. The token protects optional revocation, grants no permission, and is not an email verification link.
- [`PATCH /v1/workspace_settings`](https://api.exhibitday.com/Help/V1?epf=6#patch-v1-workspace_settings) — get the revision from [`GET /v1/workspace_settings`](https://api.exhibitday.com/Help/V1?epf=6#get-v1-workspace_settings). Covered: the 15 settings this PATCH can change, including workspace currency and the fiscal-year start month, plus whether Task Workflows and the AI Assistant are available. Saved modes of unavailable features are excluded; changing feature availability changes the token. Not covered: currency display labels, available option labels, settings timestamps, history, notification delivery, billing, membership or other settings.
- [`PATCH /v1/assets`](https://api.exhibitday.com/Help/V1?epf=5#patch-v1-assets) — get the revision from [`GET /v1/assets/info`](https://api.exhibitday.com/Help/V1?epf=5#get-v1-assets-info).
- [`POST /v1/assets/archive`](https://api.exhibitday.com/Help/V1?epf=5#post-v1-assets-archive) — get the revision from [`GET /v1/assets/info`](https://api.exhibitday.com/Help/V1?epf=5#get-v1-assets-info).
- [`POST /v1/assets/unarchive`](https://api.exhibitday.com/Help/V1?epf=5#post-v1-assets-unarchive) — get the revision from [`GET /v1/assets/info`](https://api.exhibitday.com/Help/V1?epf=5#get-v1-assets-info).
- [`DELETE /v1/assets/images`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=images#delete-v1-assets-images) — get the revision from [`GET /v1/assets/images`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=images#get-v1-assets-images). Covered: this Asset's complete image order, image filenames and saved gallery times. The token belongs to the whole gallery, so adding, deleting or reordering another image can make it stale. Not covered: the image file contents or other Asset details. Use the gallery record_revision from GET /v1/assets/images with $include_record_revision=true.
- [`PATCH /v1/assets/images/order`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=images#patch-v1-assets-images-order) — get the revision from [`GET /v1/assets/images`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=images#get-v1-assets-images). Covered: this Asset's complete image order, image filenames and saved gallery times. The token belongs to the whole gallery, so adding, deleting or reordering another image can make it stale. Not covered: the image file contents or other Asset details. Use the gallery record_revision from GET /v1/assets/images with $include_record_revision=true.
- [`PATCH /v1/assets/reservation_logistical_records`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=logistical-records#patch-v1-assets-reservation_logistical_records) — get the revision from [`GET /v1/assets/reservations/info`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=reservations#get-v1-assets-reservations-info). Covered: the selected reservation's Asset and Event associations, logistics status, dates, notes, flags, Optional Accessory quantities, Logistical Records and direct related-item links. For Collateral, this also covers its Storage Location and quantity. Send asset_type_id as well as id, because a Capital reservation and a Collateral reservation can have the same numeric id. Not covered: creation or author timestamps, or attachments. Your current access and the inventory rules are still checked separately.
- [`DELETE /v1/assets/reservation_logistical_records`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=logistical-records#delete-v1-assets-reservation_logistical_records) — get the revision from [`GET /v1/assets/reservations/info`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=reservations#get-v1-assets-reservations-info). Covered: the selected reservation's Asset and Event associations, logistics status, dates, notes, flags, Optional Accessory quantities, Logistical Records and direct related-item links. For Collateral, this also covers its Storage Location and quantity. Send asset_type_id as well as id, because a Capital reservation and a Collateral reservation can have the same numeric id. Not covered: creation or author timestamps, or attachments. Your current access and the inventory rules are still checked separately.
- [`PATCH /v1/assets/reservations`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=reservations#patch-v1-assets-reservations) — get the revision from [`GET /v1/assets/reservations/info`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=reservations#get-v1-assets-reservations-info). Covered: the selected reservation's Asset and Event associations, logistics status, dates, notes, flags, Optional Accessory quantities, Logistical Records and direct related-item links. For Collateral, this also covers its Storage Location and quantity. Send asset_type_id as well as id, because a Capital reservation and a Collateral reservation can have the same numeric id. Not covered: creation or author timestamps, or attachments. Your current access and the inventory rules are still checked separately.
- [`POST /v1/assets/cancel_reservation`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=reservations#post-v1-assets-cancel_reservation) — get the revision from [`GET /v1/assets/reservations/info`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=reservations#get-v1-assets-reservations-info). Covered: the selected reservation's Asset and Event associations, logistics status, dates, notes, flags, Optional Accessory quantities, Logistical Records and direct related-item links. For Collateral, this also covers its Storage Location and quantity. Send asset_type_id as well as id, because a Capital reservation and a Collateral reservation can have the same numeric id. Not covered: creation or author timestamps, or attachments. Your current access and the inventory rules are still checked separately.
- [`PATCH /v1/assets/inventory_adjustments`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=inventory-adjustments#patch-v1-assets-inventory_adjustments) — get the revision from [`GET /v1/assets/inventory_adjustments/info`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=inventory-adjustments#get-v1-assets-inventory_adjustments-info).
- [`DELETE /v1/assets/inventory_adjustments`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=inventory-adjustments#delete-v1-assets-inventory_adjustments) — get the revision from [`GET /v1/assets/inventory_adjustments/info`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=inventory-adjustments#get-v1-assets-inventory_adjustments-info).
- [`PATCH /v1/assets/storage_locations`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=storage-locations#patch-v1-assets-storage_locations) — get the revision from [`GET /v1/assets/storage_locations/info`](https://api.exhibitday.com/Help/V1?epf=5&amp;topic=storage-locations#get-v1-assets-storage_locations-info). Covered: the Storage Location name, address and point of contact details. Not covered: map details derived from the address, the creation timestamp, Assets or inventory transactions.
- [`PATCH /v1/financials/misc_annual_expenses`](https://api.exhibitday.com/Help/V1?epf=4&amp;topic=misc-annual-expenses-credits#patch-v1-financials-misc_annual_expenses) — get the revision from [`GET /v1/financials/misc_annual_expenses/info`](https://api.exhibitday.com/Help/V1?epf=4&amp;topic=misc-annual-expenses-credits#get-v1-financials-misc_annual_expenses-info). Covered: description, planned amount and the actual cost-center allocation rows, bound to this expense and annual budget. The budget year is checked for a match and cannot be changed by this operation. Not covered: cost-center names and the expense's creation timestamp.
- [`PATCH /v1/financials/annual_budgets`](https://api.exhibitday.com/Help/V1?epf=4#patch-v1-financials-annual_budgets) — get the revision from [`GET /v1/financials/annual_budgets`](https://api.exhibitday.com/Help/V1?epf=4#get-v1-financials-annual_budgets). Covered: the saved year and its planned number of Events, planned Exhibit amount, planned Sponsorship amount and raw Budget Notes, including native formatting. The token is bound to its workspace and saved budget row. Not covered: calculated costs, miscellaneous annual expense rows, fiscal labels/dates, creation or last-update timestamps, or display rounding and notes sanitization. Each returned year has its own optional token.
- [`PATCH /v1/events/sponsorships`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=sponsorships#patch-v1-events-sponsorships) — get the revision from [`GET /v1/events/sponsorships/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=sponsorships#get-v1-events-sponsorships-info).
- [`PATCH /v1/events/playbook_activities`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=playbook#patch-v1-events-playbook_activities) — get the revision from [`GET /v1/events/playbook_activities/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=playbook#get-v1-events-playbook_activities-info). Covered: the activity's Event association, title, description, day and times, location, type, status, role, category details, planning fields, tagged people and direct related-item links, including fields currently hidden by the activity's choices. Not covered: separate activity costs, invoice or ordinary attachments, author and creation details, or assignment-notification delivery state. Current choices and access are checked separately.
- [`PATCH /v1/events/playbook_activity_costs`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=playbook#patch-v1-events-playbook_activity_costs) — get the revision from [`GET /v1/events/playbook_activity_costs/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=playbook#get-v1-events-playbook_activity_costs-info). Covered: this cost's activity association, description, vendor/payee, reference number, dates, payment details, Notes and actual cost-center allocations. The token belongs to this one cost; use that cost's Info response, not its activity's revision. Not covered: the invoice attachment or its bytes, cost-center names, creation or last-modified timestamps, or the activity's other costs and details.
- [`PATCH /v1/events/staff`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=staff#patch-v1-events-staff) — get the revision from [`GET /v1/events/staff/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=staff#get-v1-events-staff-info). Covered: this entry's Event and person associations, role, attendance format, registration type, confirmation/reference number, link, Notes, payment details, actual cost-center allocations and direct related-task links. Not covered: the invoice or ordinary attachments, notification delivery/copy/author bookkeeping, creation timestamp, or current person/role/cost-center display names. Current person availability, role choices and Event access are checked separately.
- [`PATCH /v1/events/objectives`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=objectives#patch-v1-events-objectives) — get the revision from [`GET /v1/events/objectives/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=objectives#get-v1-events-objectives-info). Covered: the objective’s Event association, type, Other name, importance and achievement rating. The type and Other name are set when adding it. Not covered: its added timestamp, current objective-type or importance labels, the Event’s other objectives or overall scores. Current access and available custom objectives are checked separately.
- [`PATCH /v1/events/booth_services`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=booth-services#patch-v1-events-booth_services) — get the revision from [`GET /v1/events/booth_services/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=booth-services#get-v1-events-booth_services-info). Covered: the service type, acquisition and order details, vendor information, payment fields, Notes, all saved service details (including previous families and Labor subtypes), actual cost-center allocations and direct related-item links. Not covered: invoice or ordinary attachments, their contents, creation timestamp, cost-center/type labels or the Event's planned budget. Use this service's Info response for its token.
- [`PATCH /v1/events/travel_reservations`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=travel-reservations#patch-v1-events-travel_reservations) — get the revision from [`GET /v1/events/travel_reservations/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=travel-reservations#get-v1-events-travel_reservations-info). Covered: this reservation's Event association, type and booking details, complete outward and return details, Notes, current and dormant stored payment fields, complete tagged-person identities, actual cost allocations and direct related-item links. Not covered: invoice and ordinary attachments or bytes, creation and notification bookkeeping, display rank, duplicate-source identity, current type/person/cost-center labels and related-record display data. Use this reservation's Info revision. Current Event access, available types, membership and related items are checked separately.
- [`PATCH /v1/events/giveaways`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=giveaways#patch-v1-events-giveaways) — get the revision from [`GET /v1/events/giveaways/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=giveaways#get-v1-events-giveaways-info). Covered: this Giveaway's Event association, Name, Source, supplier and acquisition details, all Details and Notes, entry and distribution choices, payment details, complete actual cost allocations and direct related-item links. Not covered: its invoice and ordinary attachments or bytes, creation timestamp, current cost-center names or related-record display data. Use this Giveaway's Info revision; current Event access and related-item availability are checked separately.
- [`PATCH /v1/events/shipments`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=shipments#patch-v1-events-shipments) — get the revision from [`GET /v1/events/shipments/info`](https://api.exhibitday.com/Help/V1?epf=1&amp;topic=shipments#get-v1-events-shipments-info). Covered: Shipment name, carrier, pickup and delivery details, status, payment fields, Notes, every component and its identity, actual cost-center allocations and direct related-item links. Not covered: invoice or ordinary attachment records, captions or file contents, creation timestamps, workspace measurement settings, lookup labels or the Event's planned Shipments budget. A real name change may also refresh the invoice caption; caption edits by themselves do not change this business token. Use this Shipment's Info response for its token.
- [`PATCH /v1/tasks/sections`](https://api.exhibitday.com/Help/V1?epf=2#patch-v1-tasks-sections) — get the revision from [`GET /v1/tasks/sections/info`](https://api.exhibitday.com/Help/V1?epf=2#get-v1-tasks-sections-info). Covered: the section name and the Event it belongs to. Not covered: its display order, creation timestamp, tasks, comments or files. Use this section's Info response for the revision; current access and Tasks locks are checked separately.
- [`PATCH /v1/events/dates`](https://api.exhibitday.com/Help/V1?epf=1#patch-v1-events-dates) — get the revision from [`GET /v1/events/dates`](https://api.exhibitday.com/Help/V1?epf=1#get-v1-events-dates). Covered: this Event and logical Dates type, and every saved date, start time, end time, time-zone label and description in the selected group, including duplicate rows and an empty list. Not covered: physical Date-row IDs or creation times, either other Dates group, the Event main start/end dates, locks, or history. Use the token from the same Event and date_type_id; it belongs to the complete group, not to an individual Date row.

## Guides

## Get data into ExhibitDay

- [Create or Update Events from Your CRM](https://api.exhibitday.com/Help/V1?guide=event-setup-crm) — Create an Event from a CRM record (for example Salesforce, HubSpot or Zoho CRM), or update the Event already linked to it.
- [Set an Event's Exhibit Hall Dates and Hours](https://api.exhibitday.com/Help/V1?guide=dates-times-time-zones) — Set an Event's Exhibit Hall days, hours and time zone, then confirm them.
- [Reserve Assets (Equipment and Materials) for an Event](https://api.exhibitday.com/Help/V1?guide=reserve-change-cancel-assets) — Reserve equipment or materials for an Event, change the reservation, and see what canceling would do.
- [Update Collateral Stock After a Delivery or Recount](https://api.exhibitday.com/Help/V1?guide=collateral-inventory-storage) — Record a stock delivery or recount for Collateral at a Storage Location.
- [Add Attendees and Their Travel Reservations to an Event](https://api.exhibitday.com/Help/V1?guide=staff-travel-tags) — Register a person for an Event and record their hotel, then list everything for that person.
- [Record Show Results: Leads and Objective Ratings](https://api.exhibitday.com/Help/V1?guide=show-results-objectives) — Record a show's lead count and how well an Objective was met.
- [Copy Tasks from a Previous Event](https://api.exhibitday.com/Help/V1?guide=reuse-event-plan) — Copy last year's Tasks into this year's Event instead of rebuilding the checklist.
- [Record Costs and Split Them Across Cost Centers](https://api.exhibitday.com/Help/V1?guide=entering-costs) — Record a cost on a record, and optionally split it across cost centers.
- [Create Tasks from Forms, Tickets or Other Apps](https://api.exhibitday.com/Help/V1?guide=create-tasks) — Turn a form, ticket or plan item from another app (for example Google Forms, Zendesk or Jira) into an Event Task.
- [Fill In Your Custom Event Fields from Another System](https://api.exhibitday.com/Help/V1?guide=custom-fields) — Fill in or read your workspace's own Event fields from another system.

## Get data out

- [Get a Complete List of Attendees, Travel and More](https://api.exhibitday.com/Help/V1?guide=find-filter-page) — Pull a complete filtered list, such as everyone registered or traveling for a show, page by page.
- [Search Activity Audit Logs to See Who Changed What, and When](https://api.exhibitday.com/Help/V1?guide=workspace-activity) — See who changed what and when, for audits, investigations or monitoring.
- [Export Event Costs to Excel or a Reporting Tool](https://api.exhibitday.com/Help/V1?guide=export-event-costs) — Save your Event costs to a CSV for Excel, Google Sheets, Power BI or another reporting tool.

## Keep systems in sync

- [Link ExhibitDay Events to Your CRM or ERP Records](https://api.exhibitday.com/Help/V1?guide=match-records) — Link each record in your CRM or ERP (for example Salesforce, HubSpot or NetSuite) to the matching ExhibitDay Event, even after names change.
- [Update Shipment Tracking and Status Automatically](https://api.exhibitday.com/Help/V1?guide=shipment-tracking) — Add tracking numbers and Shipped status to Event Shipments from your shipping system or carrier (for example FedEx or UPS).
- [Keep Another System Updated with Event and Task Changes](https://api.exhibitday.com/Help/V1?guide=sync-changes) — Keep a copy of your Events and Tasks in another system, refreshed with only what changed.

## Do it safely

- [Avoid Overwriting Someone Else's Changes](https://api.exhibitday.com/Help/V1?guide=update-records-safely) — Update a record only if nobody else changed it since you read it.
- [Handle Errors and Retry Failed Requests](https://api.exhibitday.com/Help/V1?guide=errors-and-retries) — Know what to do when a request fails: fix it, wait and retry, or check whether it already worked.

## Key terms

## ExhibitDay terms

**Workspace** your company's ExhibitDay account. Each API key belongs to one workspace. **Event** a show, conference or meeting you plan for. Most records belong to an Event. **Event tabs** the areas of an Event page, such as Information, Tasks, Staff, Travel and Shipments. Some API calls refer to them. **Task** A to-do item. You can link it to an Event or keep it as a general Task. **Task Section** a group that Tasks are listed under on an Event. **Asset** Equipment or materials your workspace tracks for events. **Capital Asset** an Asset tracked one item at a time, such as a monitor or a booth structure. **Collateral** Assets tracked by quantity, such as brochures or giveaways. **Storage Location** where Assets are kept when they're not at an event. **Reservation** A booking for an Asset. A reservation can be for an Event or another purpose. **Inventory adjustment** a manual change to Collateral stock, such as a delivery or a recount. **Logistical record** a preparation milestone on a reservation, such as "Packed" or "Shipped". **Cost center** a budget category that a cost can be split across. **Budget year** the year a cost counts toward, based on your workspace's fiscal-year start month. **Users and Resources** Users can sign in to ExhibitDay. Resources are entries without sign-in access. **Custom fields** fields your workspace adds to Events or Assets. **Integration fields** Five API-only text fields on Events, Tasks, Misc. Expenses / Credits and Assets, named `integration_metadata_field_1` through `integration_metadata_field_5`. Use them to store another system’s ID so you can find the record again even if its name changes.

## API terms

**API key** identifies your workspace on every request. Keep it private. **ID** the value that identifies a record, usually a number and sometimes text. Save it to read or update the record later. **Record revision** a value returned with a record that represents its current saved state. **Expected revision** The record revision you send back with a supported update. The API checks that the values covered by that revision still match. **Idempotency-Key** A value you choose for a supported create request. During the replay window, retry the same request with the same key to avoid a duplicate. **Warnings** notes in the `X-API-Warnings` response header about inputs that were ignored or adjusted. The request still succeeded. **Paging** reading a long list a page at a time with `$limit` (how many) and `$offset` (how many to skip). **error_code / error_params** what went wrong with a request, and which inputs to fix. **Request ID** An identifier in the `X-Request-Id` response header. Include it when contacting support. **Ignore-empty option** `$ignore_params_with_empty_values=true` skips blank values on operations that support it.
