Search API documentation

Type to search the API docs.

Build an Event Binder for the On-Site Team

Download an Event Binder as PDF or Word with the sections your on-site team needs.

Example use case

Your booth crew needs one document with the venue details, booth setup, asset reservations, shipments and Tasks for show week.

What you'll end up with

A PDF you can open offline or print. If your plan includes Word Binders, you can download a Word document to edit before sharing.

Before you start

Have the Event ID and a workspace API key that can read the Event. In the app, the same report is available from the Event's Event Binder (.pdf export) menu item.

Good to know

The Binder contains selected Event sections. Files attached to the Event and Task comments are outside the export.

At a glance

Time to try

About 5 minutes

Effect on your data

Read-only

Endpoints

1

ExhibitDay creates a private download without editing the Event or sending notifications. The example saves the file on your computer.

How it works

  1. Choose the Event and the sections the on-site team needs.
  2. Request the Binder and save the successful file response.
  3. Open the file and review the sections and details before you send it to the crew.

Export a Binder for show week

Step 1: Pick the sections to include

For this crew, keep the cover page, Event Information, Booth, Booth Services, Asset Reservations, Shipments and Tasks. Those are on by default. The example switches off the other default sections and all cost switches. Budget, ROI and ROO are already off by default.

Use separate switches for a section and its costs. For example, set include_shipments=true and include_shipments_costs=false to include shipment logistics without permitted shipment costs and payment details. Review Staff and Travel before sharing either section, since they can contain personal information.

Step 2: Download the PDF

Replace 23456 with the Event ID and use your API key in the Authorization header. PDF is the default. Use format=docx for Word if your plan includes Word Binders, and save it with a .docx extension.

# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/events/binder/export?event_id=23456&format=pdf&include_special_tab=false&include_booth_costs=false&include_booth_services_costs=false&include_staff=false&include_staff_costs=false&include_travel=false&include_travel_costs=false&include_giveaways=false&include_giveaways_costs=false&include_shipments_costs=false&include_sponsorships=false&include_sponsorships_costs=false&include_playbook=false&include_playbook_costs=false&include_misc_expenses_credits=false&include_misc_expenses_credits_costs=false" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'event-binder.pdf'

Example response headers (shortened)

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename=event-binder.pdf

Check: The complete example saves the body only after HTTP 200. In your own integration, also check Content-Type before saving the response body as a file. For Word, the media type is application/vnd.openxmlformats-officedocument.wordprocessingml.document. If the API returns an error, read the JSON response.

Try it

Before running the example

ValueWhat to put in it
YOUR_API_KEYYour workspace API key. Keep it out of shared code and logs.
event_idThe ID of the Event for which you want a Binder.
formatThe sample uses pdf. To request Word, use docx and change the output filename.
event-binder.pdfThe local output file. Choose a fresh folder or output name to keep an earlier Binder.

Copy the complete example in your language and run it from an empty, private folder. It saves the PDF as event-binder.pdf. Open the saved file and confirm the Event name, the included sections and the details you intend to share.

Complete example program

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/events/binder/export?event_id=23456&format=pdf&include_special_tab=false&include_booth_costs=false&include_booth_services_costs=false&include_staff=false&include_staff_costs=false&include_travel=false&include_travel_costs=false&include_giveaways=false&include_giveaways_costs=false&include_shipments_costs=false&include_sponsorships=false&include_sponsorships_costs=false&include_playbook=false&include_playbook_costs=false&include_misc_expenses_credits=false&include_misc_expenses_credits_costs=false" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'event-binder.pdf'

Example response

File: event-binder.pdf
Content type: application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document
Note: The response body contains file bytes.

The curl example uses Bash. Node.js needs version 18 or later (save as .mjs). Python uses Requests. C# needs a .NET 8 console project (Program.cs). Java needs Java 11 or later (ExhibitDayExample.java). PHP needs PHP with cURL. Ruby and Go use their standard libraries.

Things to keep in mind

  • ExhibitDay includes selected sections that are available for this Event and workspace. A hidden Booth tab also removes Booth Services. Budget requires Budgeting. ROI and ROO require Analytics & ROI. ROO can still appear with the ROI tab hidden.
  • Cost switches can hide financial details within their sections. They cannot grant financial access. Budget has its own switch, and a PDF may have a watermark depending on your plan.
  • Each export reads current Event information as the report is prepared. Export again near show time if plans have changed. Check the new document before replacing the copy your crew has.

If the request fails

If no selected section is available, the API returns HTTP 400 (invalid_request). Select one that is, such as Event Information. If Word is not in your plan, it returns HTTP 400 (not_allowed); request PDF. If you get record_changed (HTTP 409), review the current Event and selected sections before requesting a new Binder.