EventsStaff

Staff

Retrieve a Single Attendee / Registration by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single Attendee / Registration by its ID.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the attendee / registration record.
Use the id from Retrieve Attendees / Registrations (GET /v1/events/staff) or from the add response. You don't send the Event ID; the record's Event is found automatically.
$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 | object
$include_record_revision Boolean No
Whether to include record_revision in the response.
Default: false. Send true to get record_revision, then send that value as expected_revision when you update this registration. See What $include_record_revision covers below.
$on_error_return_empty_result Boolean No
Whether an invalid or unavailable registration should return an empty result.
Default: false. True returns HTTP 200 with {} (or [] for array format) for invalid IDs or an unavailable registration. API key errors, conflicts with a change in progress and unexpected errors keep their normal status.
If-None-Match String No
An ETag from an earlier response to this GET.
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.

Good to know

Retrieves an attendee or registration by its ID, including the assigned person or resource, role, attendance format, registration details, costs and payment information. You can find this record on the Event's Staff tab.

What $include_record_revision covers

Setting $include_record_revision=true returns record_revision for use as expected_revision on a later update.

record_revision covers the registration's assigned person, role, attendance format, notes, registration and payment fields, cost allocations, related-item links and Event binding. It does not cover File Attachments or Invoice Attachment metadata or contents.

File Attachments and the Invoice Attachment

invoice_attachment contains the registration's Invoice Attachment metadata, or null when no invoice is attached. Ordinary File Attachments are retrieved separately through the registration's File Attachment collection.

Access

The Event's Staff tab must be visible, and access to registration financial details is required. The tab can be locked while you read it.

Formatted text in the response

Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.

Open in ExhibitDay

Each record includes exhibitday_url, the record's page in ExhibitDay. It opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/staff/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "id": 12345,
  "event_id": 23456,
  "event_name": "Sample Event",
  "attendee": {
    "id": "11111111-2222-4333-8444-555555555555",
    "first_name": "Jane",
    "last_name": "Smith",
    "display_name": "Jane Smith",
    "email": "jane@example.invalid",
    "type": "user",
    "workspace_role": "team_member",
    "is_active": true
  },
  "attendee_role_id": 1,
  "attendee_role": "Not Specified",
  "attendance_format_id": null,
  "attendance_format": "Not Specified",
  "registration_type": "Conference pass",
  "registration_confirmation_number": "",
  "registration_url": null,
  "notes": "",
  "payment_status_id": 0,
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": {
    "id": 782345,
    "filename": "registration-invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  },
  "cost": {
    "amount": 125.50,
    "cost_center_breakdown": [
      {
        "cost_center_id": 34567,
        "cost_center": "Marketing",
        "charge": 75.50
      },
      {
        "cost_center_id": 34568,
        "cost_center": "Operations",
        "charge": 50.00
      }
    ]
  },
  "created_by": {
    "id": "11111111-2222-4333-8444-555555555555",
    "first_name": "Jane",
    "last_name": "Smith",
    "display_name": "Jane Smith",
    "email": "jane@example.invalid",
    "type": "user",
    "workspace_role": "team_member",
    "is_active": true
  },
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=10&riSub=0&riId=12345",
  "related_items": [
    {
      "id": 5551,
      "related_item_id": 67890,
      "related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=67890",
      "related_item_type_id": 1,
      "related_item_type": "Task",
      "related_item_asset_type_id": null,
      "related_item_name": "Confirm booth graphics with the printer",
      "related_item_created_timestamp": "2030-01-10T14:03:00Z"
    },
    {
      "id": 5552,
      "related_item_id": 45678,
      "related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/RelatedItemView/98765?typeId=4&subTypeId=0&rid=45678",
      "related_item_type_id": 4,
      "related_item_type": "Shipment",
      "related_item_asset_type_id": null,
      "related_item_name": "Booth crates to convention center",
      "related_item_created_timestamp": "2030-01-10T14:03:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Retrieve Attendees / Registrations #

Method
GET
Endpoint

Retrieves Attendees / Registrations across the Events you can read.

Parameters
Name Type Required? Description Details
filter_by_event_id Number No
Return records for this Event only. Omit for all readable Events in your workspace.
filter_by_attendee_user_ids String or JSON array No
Return entries assigned to any of these users or resources. Send one user ID or an array of user IDs, for example "user-id" or ["user-id","other-user-id"]. Omit, leave blank or send [] for no user filter. Duplicate IDs collapse. Inactive and deactivated people, and people no longer in this workspace, still match the entries they are assigned to; IDs never assigned in this workspace match nothing. This filter combines with the other filters before counting and paging.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "oneOf": [
    {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "\\S"
    },
    {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128,
        "pattern": "\\S"
      }
    }
  ],
  "x-normalization": "one string becomes a one-item array; trimmed distinct IDs; no record-count cap",
  "nullable": false,
  "x-maximum-depth": 1,
  "x-empty-create-means-omitted": false,
  "example": [
    "user-id"
  ]
}
$limit Number No
The most registrations to return: a whole number of 1 or more. Omit it for all remaining matches; a blank value or null is refused, so leave the parameter out instead.
$offset Number No
How many matching registrations to skip: a whole number of 0 or more. Default: 0. A blank value or null is refused.
$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
hydrate_related_items Boolean No
Set to true to include each record's related_items: the Tasks and items linked to it, with the key to use when adding or removing a link. Omit it or send false to leave related_items out of list results. Single-record GETs always include related_items.
Default: false.

Good to know

Retrieves records across your workspace's readable Event tabs. Use filter_by_event_id to narrow the results to one Event, or omit it for the workspace list. Each record includes its event_id and Event name. Use filter_by_attendee_user_ids to match any assigned user or Resource in your selection. Omit the filter to include unassigned entries too.

Choosing Events

Omit filter_by_event_id to retrieve records across readable Event tabs, or supply one Event ID to narrow the list. Each result retains its own event_id and Event name.

Hidden or unavailable Event tabs are not included. A locked tab can still be read. If no records match, the response is an empty list.

Filtering assigned people

filter_by_attendee_user_ids accepts one user ID string or an array of user IDs. A record matches any selected assigned user or Resource. Unassigned entries are excluded while this filter is set. Omit it or send [] for no user filter.

Stored assignments and tags match directly: inactive and deactivated people, Resources and people no longer in this workspace still match the records they are on. IDs never used on this workspace's records match nothing; this is not an error. The people and Event filters combine with AND before counting and paging.

Reading pages

The Event filter and any people filter are applied before the total count and paging. Results are ordered by Event start date ascending, Event ID ascending, then record ID ascending.

Use $limit and $offset for successive pages. Omit $limit to return all remaining matches. total_records and X-Total-Count describe all matches; records_found counts this response.

Omit $result_format for the normal list wrapper. array returns only the records; wrapped_in_array places the normal wrapper in a one-item array.

Handling input and changes

Unrecognized parameters are ignored and listed in the X-API-Warnings response header. Conflicting or malformed filter values return HTTP 400; send arrays in JSON, query parameters or form fields rather than comma-bearing headers.

Current API access is checked even when the list is empty. A concurrent change can return HTTP 409; retrieve the list again. These filters retrieve records and do not change tags, assignments or notification settings.

Related items

Set hydrate_related_items=true to include each record's related_items: the Tasks and items linked to it. Add or remove links with POST and DELETE /v1/related_items. It is left out by default to keep lists fast. Retrieving one record always includes related_items.

Formatted text in the response

Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.

Events with a hidden Staff tab

Records on Events whose Staff tab is hidden are not listed. If filter_by_event_id names such an Event, the response is HTTP 200 with no records for it and a warning that names the tab and the Event.

Open in ExhibitDay

Each record includes exhibitday_url, the record's page in ExhibitDay. It opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/staff" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "list_type": "staff_entry",
  "list_data": [
    {
      "id": 12345,
      "event_id": 23456,
      "event_name": "Sample Event",
      "attendee": {
        "id": "11111111-2222-4333-8444-555555555555",
        "first_name": "Jane",
        "last_name": "Smith",
        "display_name": "Jane Smith",
        "email": "jane@example.invalid",
        "type": "user",
        "workspace_role": "team_member",
        "is_active": true
      },
      "attendee_role_id": 1,
      "attendee_role": "Not Specified",
      "attendance_format_id": null,
      "attendance_format": "Not Specified",
      "registration_type": "Conference pass",
      "registration_confirmation_number": "",
      "registration_url": null,
      "notes": "",
      "payment_status_id": 0,
      "payment_status": {
        "id": 0,
        "name": "N/A"
      },
      "payment_due_date": null,
      "next_payment_due_date": null,
      "payment_notes": null,
      "invoice_attachment": {
        "id": 782345,
        "filename": "registration-invoice.pdf",
        "attachment_created_timestamp": "2027-01-30T12:00:00Z"
      },
      "cost": {
        "amount": 0.00,
        "cost_center_breakdown": []
      },
      "created_by": {
        "id": "11111111-2222-4333-8444-555555555555",
        "first_name": "Jane",
        "last_name": "Smith",
        "display_name": "Jane Smith",
        "email": "jane@example.invalid",
        "type": "user",
        "workspace_role": "team_member",
        "is_active": true
      },
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=10&riSub=0&riId=12345"
    }
  ],
  "records_found": 1,
  "total_records": 1,
  "has_more": false
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add an Attendee / Registration #

Method
POST
Endpoint

Adds an Attendee / Registration to an Event.

Parameters
Name Type Required? Description Details
event_id Number Yes
The ID of the Event.
attendee_user_id String No
The person or resource assigned to this registration.
Use a current, active workspace user or resource ID. Omit or send null for an unassigned registration. A person or resource can appear only once in an Event's Staff list. Maximum: 128 characters.
attendee_role_id Number No
The assigned person's attendee role.
Use a currently available Attendee Role ID. Omit to use the selected person's configured default, or Not Specified (1) if that default is unavailable. With no person assigned, attendee_role_id is ignored, the role is Not Specified (1), and the response includes a warning saying so.
attendance_format_id Number No
Whether the assigned person attends onsite or remotely. Null means Not Specified. For an assigned person, omission uses the workspace's default. An unassigned entry always has no attendance format; a value sent for one is ignored, and the response includes a warning saying so.
Allowed values: 1 (Onsite) | 2 (Remote)
notes String No
Notes about this attendee or registration.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Up to 4,000 characters as saved: characters such as & and < and each line break take extra space. Longer text is refused rather than shortened. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
registration_url String No
The registration or ticket link.
Up to 2,000 characters after surrounding spaces are removed. Kept as typed; the API does not add or rewrite a URL scheme. Omit for no value.
registration_type String No
The registration or ticket type.
Up to 300 characters, excluding surrounding spaces. Omit for no value.
registration_confirmation_number String No
The registration confirmation or reference number.
Up to 200 characters, excluding surrounding spaces. Omit for no value.
payment_status_id Number No
The registration's payment status. Omit or send null for N/A. A status other than Partially Paid clears the next partial payment due date.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
The registration payment due date.
Use a calendar date in YYYY-MM-DD format. Omit for no value.
next_payment_due_date Date No
The next partial payment due date.
Use a calendar date in YYYY-MM-DD format. Applies when payment_status_id is Partially Paid (2). Supplying this date with another status clears it; choosing another status also clears it. Omit for no value.
payment_notes String No
Notes about the registration payment.
Up to 200 characters, excluding surrounding spaces. Omit for no value.
cost Number or cost object No
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0,
      "description": "Shorthand for an object with amount. The amount is rounded to cents before the supported storage range is checked.",
      "nullable": true
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0.0,
          "maximum": 79228162514264337593543950335.0
        },
        "cost_center_breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "cost_center_id": {
                "type": "integer",
                "format": "int64",
                "nullable": true
              },
              "charge": {
                "type": "number",
                "minimum": 0.0,
                "maximum": 79228162514264337593543950335.0
              },
              "cost_center": {
                "type": "string",
                "description": "Optional and read-only: the cost center name a read returns, so a cost can be sent back unchanged. It is ignored; the line is saved by cost_center_id, and a name that doesn't match that cost center is explained in a warning.",
                "nullable": true
              }
            },
            "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
            "required": [
              "charge"
            ]
          },
          "maxItems": 2147483647
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "anyOf": [
        {
          "required": [
            "amount"
          ]
        },
        {
          "required": [
            "cost_center_breakdown"
          ]
        }
      ],
      "nullable": true
    }
  ],
  "x-numeric-shorthand": "A number is equivalent to {amount:number}.",
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": {
    "amount": 125.50
  }
}
Optional; defaults to zero.
notify_attendee Boolean No
Whether to send the usual assignment email to a newly assigned person.
Default: true when omitted or blank. Send false to skip that new notification. It does not resend or cancel notifications for an unchanged person. Resources and unassigned entries receive no email; delivery also depends on the person's current account, access and email preferences. JSON null is refused.
$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 | object
Idempotency-Key String No
A unique key for safely retrying this add request.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces. Retry the identical request with the same key to replay its first saved response. Use a new key for a different request.
$request_principal_name String No
A display label for the API origin of a new assignment.
Optional, up to 122 characters. Default: ExhibitDay API. Used when this operation creates or reassigns the registration. It does not identify a workspace user or change permissions.

Good to know

Adds an attendee or registration record to an Event's Staff tab. Supply attendee_user_id to assign it to a person or resource, or leave attendee_user_id out to track an unassigned registration.

Choosing who attends

Use attendee_user_id for a person or resource, or omit it to record an unassigned registration. A person or resource can be added only once per Event.

For an assigned person, omit attendee_role_id and attendance_format_id to use the applicable defaults described in the table. Unassigned registrations have no role or attendance format.

After the add

The response contains the new registration and its id. No File Attachment or Invoice Attachment is uploaded by this operation; those use their separate file operations.

The change is recorded in Event history. A newly assigned person may receive an assignment email unless notify_attendee is false. If the save outcome cannot be confirmed, retrieve the registrations before deciding whether to retry.

Access

The Event's Staff tab must be visible and unlocked. You need permission to manage its attendees / registrations and access their registration financial details.

Sending values

Use JSON, a form field or a query parameter for text or lists containing commas.

Sending text

Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.

Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.

Hidden or locked tab

If the Event's Staff tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Open in ExhibitDay

The created record includes exhibitday_url, the record's page in ExhibitDay. It is the same link that GET /v1/events/staff/info returns for this record and opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/events/staff" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"event_id\":23456,\"registration_type\":\"Conference pass\"}"

Example response

{
  "id": 12345,
  "event_id": 23456,
  "event_name": "Sample Event",
  "attendee": {
    "id": "11111111-2222-4333-8444-555555555555",
    "first_name": "Jane",
    "last_name": "Smith",
    "display_name": "Jane Smith",
    "email": "jane@example.invalid",
    "type": "user",
    "workspace_role": "team_member",
    "is_active": true
  },
  "attendee_role_id": 1,
  "attendee_role": "Not Specified",
  "attendance_format_id": null,
  "attendance_format": "Not Specified",
  "registration_type": "Conference pass",
  "registration_confirmation_number": "",
  "registration_url": null,
  "notes": "",
  "payment_status_id": 0,
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": null,
  "cost": {
    "amount": 0.00,
    "cost_center_breakdown": []
  },
  "created_by": {
    "id": null,
    "first_name": "ExhibitDay",
    "last_name": "API",
    "display_name": "ExhibitDay API",
    "email": null,
    "type": null,
    "workspace_role": null,
    "is_active": true
  },
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=10&riSub=0&riId=12345"
}
Note: IDs are illustrative; use IDs from your workspace.

Update an Attendee / Registration #

Method
PATCH
Endpoint

Updates an existing Attendee / Registration.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the attendee / registration record.
Use the record's id from GET /v1/events/staff or from its add or single-record response. It is not the person's ID: the assigned person or Resource is the attendee object in those responses.
attendee_user_id String No
The person or resource assigned to this registration.
Use a current, active workspace user or resource ID to change the assignment. Maximum: 128 characters. Omit or leave blank to keep it; null makes the entry unassigned. An existing inactive or former member can remain assigned while you edit other fields.
attendee_role_id Number No
The assigned person's attendee role.
Use a currently available Attendee Role ID. Omit or leave blank to keep the role, except that assigning a different person uses their default role when this is omitted. Null cannot clear the role. With no person assigned, a role you send is ignored, the role stays Not Specified (1), and the response includes a warning saying so.
attendance_format_id Number No
Whether the assigned person attends onsite or remotely. Omit or leave blank to keep it; null means Not Specified. An unassigned entry always has no attendance format; a value sent for one is ignored, and the response includes a warning saying so.
Allowed values: 1 (Onsite) | 2 (Remote)
notes String No
Notes about this attendee or registration.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Up to 4,000 characters as saved: characters such as & and < and each line break take extra space. Longer text is refused rather than shortened. Omit or leave blank to keep it; null clears it. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
registration_url String No
The registration or ticket link.
Up to 2,000 characters after surrounding spaces are removed. Kept as typed; the API does not add or rewrite a URL scheme. Omit or leave blank to keep it; null clears it.
registration_type String No
The registration or ticket type.
Up to 300 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
registration_confirmation_number String No
The registration confirmation or reference number.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
payment_status_id Number No
The registration's payment status. Omit or leave blank to keep it; null cannot clear it. A status other than Partially Paid clears the next partial payment due date.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
The registration payment due date.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it.
next_payment_due_date Date No
The next partial payment due date.
Use a calendar date in YYYY-MM-DD format. Applies when payment_status_id is Partially Paid (2). Supplying this date with another status clears it; choosing another status also clears it. Omit or leave blank to keep it; null clears it.
payment_notes String No
Notes about the registration payment.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
cost Number or cost object No
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0,
      "description": "Shorthand for an object with amount. The amount is rounded to cents before the supported storage range is checked.",
      "nullable": true
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0.0,
          "maximum": 79228162514264337593543950335.0
        },
        "cost_center_breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "cost_center_id": {
                "type": "integer",
                "format": "int64",
                "nullable": true
              },
              "charge": {
                "type": "number",
                "minimum": 0.0,
                "maximum": 79228162514264337593543950335.0
              },
              "cost_center": {
                "type": "string",
                "description": "Optional and read-only: the cost center name a read returns, so a cost can be sent back unchanged. It is ignored; the line is saved by cost_center_id, and a name that doesn't match that cost center is explained in a warning.",
                "nullable": true
              }
            },
            "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
            "required": [
              "charge"
            ]
          },
          "maxItems": 2147483647
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "anyOf": [
        {
          "required": [
            "amount"
          ]
        },
        {
          "required": [
            "cost_center_breakdown"
          ]
        }
      ],
      "nullable": true
    }
  ],
  "x-numeric-shorthand": "A number is equivalent to {amount:number}.",
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": {
    "amount": 125.50
  }
}
Omit to keep the saved cost. A supplied value replaces its full allocation.
notify_attendee Boolean No
Whether to send the usual assignment email to a newly assigned person.
Default: true when omitted or blank. Send false to skip that new notification. It does not resend or cancel notifications for an unchanged person. Resources and unassigned entries receive no email; delivery also depends on the person's current account, access and email preferences. JSON null is refused.
expected_revision String No
The record_revision from an earlier read of this registration.
Optional. Obtain it from GET /v1/events/staff/info with $include_record_revision=true. If the covered values changed, the update returns HTTP 409 without saving it. Omission skips this conflict check; blank, null and malformed values are refused.
$ignore_params_with_empty_values Boolean No
Whether JSON null should leave the current value unchanged.
Default: false. With true, whole JSON null values are ignored. The text null still clears a field that supports clearing. Blank ordinary values already leave their fields unchanged. This does not relax notify_attendee validation.
$request_principal_name String No
A display label for the API origin of a new assignment.
Optional, up to 122 characters. Default: ExhibitDay API. Used when this operation creates or reassigns the registration. It does not identify a workspace user or change permissions.

Good to know

Updates an attendee or registration on an Event's Staff tab. Send only the values you want to change, such as the assigned person, registration details or payment information.

Choosing what to change

Omitted or blank ordinary values stay unchanged. Send null to clear a field that supports it; attendee_role_id and payment_status_id cannot be cleared. Costs and related-item links have the separate rules in the table.

Clearing attendee_user_id makes the registration unassigned and resets its role and attendance format. Changing the person can schedule a new assignment email; notify_attendee=false skips that new notification.

A real change adds one Event history entry. An unchanged request saves no business data or history and keeps its revision. Files and the Invoice Attachment are managed separately.

Using expected_revision

  1. Retrieve this registration with GET /v1/events/staff/info and $include_record_revision=true.
  2. Send the returned record_revision unchanged as expected_revision with this update.
  3. If the API reports that the registration changed, read its current values and decide what to update.

Access

The Event's Staff tab must be visible and unlocked. You need permission to manage its attendees / registrations and access their registration financial details.

If the save cannot be confirmed

Read the registration before deciding whether to retry. The API does not automatically repeat an unconfirmed save.

Sending values

Use JSON, a form field or a query parameter for text or lists containing commas.

Sending text

Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.

Hidden or locked tab

If the Event's Staff tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/events/staff" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"notes\":\"Updated text\"}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Staff / Registration entry updated.",
  "errors": []
}

Delete an Attendee / Registration #

Method
DELETE
Endpoint

Deletes an existing Attendee / Registration.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the attendee / registration record.
Use the record's id from GET /v1/events/staff or from its add or single-record response. It is not the person's ID: the assigned person or Resource is the attendee object in those responses.

Good to know

Deletes an attendee or registration from an Event's Staff tab, together with its costs, related-item links, File Attachments and Invoice Attachment. It does not remove the person or resource from your workspace.

After the deletion

The registration, its costs, related-item links, File Attachment records and Invoice Attachment are removed together. Its files are scheduled for physical cleanup after the save. The deletion is recorded in Event history; it sends no assignment email.

The workspace person or resource and the linked Tasks remain. A registration that is no longer available returns HTTP 404. If the save outcome cannot be confirmed, retrieve the current registrations before deciding whether to retry.

Access

The Event's Staff tab must be visible and unlocked. You need permission to manage its attendees / registrations and access their registration financial details.

Hidden or locked tab

If the Event's Staff tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/staff?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Staff / Registration entry removed.",
  "errors": []
}

Download Attendee / Registration Invoice Attachment #

Method
GET
Endpoint

Downloads the Invoice Attachment for an Attendee / Registration.

Parameters
Name Type Required? Description Details
staff_entry_id Number Yes
The ID of the Attendee / Registration record, from Retrieve Attendees / Registrations (GET /v1/events/staff) or its add response.

Good to know

Downloads the original Invoice Attachment for this Attendee / Registration. Use this method to retrieve the file itself.

Finding the file

In the web app, this is the invoice control beside the Attendee / Registration record's cost and payment details. Each cost has one Invoice Attachment even when its amount is split among cost centers.

For file metadata, retrieve the parent record with GET /v1/events/staff/info and read invoice_attachment. Use this download method for the contents. No attachment ID or invoice flag is needed.

Download response

A successful response contains the original uploaded file, with a safe download filename. API errors use the usual JSON response. If no invoice is attached, this method returns HTTP 404.

Current record, financial and invoice permissions apply. A locked tab can still be read. Permitted downloads remain available on the Free plan.

Files still being copied

If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.

Hidden tab

If the Event's Staff tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

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/staff/invoice_attachment/download?staff_entry_id=12345" -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 'invoice.pdf'

Example response

File: invoice.pdf
Content type: application/octet-stream
Note: The response body contains file bytes.

Add Attendee / Registration Invoice Attachment #

Method
POST
Endpoint

Adds an Invoice Attachment to an Attendee / Registration.

Parameters
Name Type Required? Description Details
staff_entry_id Number Yes
The ID of the Attendee / Registration record, from Retrieve Attendees / Registrations (GET /v1/events/staff) or its add response.
file File (multipart) Yes
The Invoice Attachment to upload.

Maximum size per file: 25 MiB (26,214,400 bytes).

Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip.

Maximum files per request: 1.

View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "string",
  "format": "binary",
  "x-maximum-bytes": 26214400,
  "x-allowed-extensions": [
    "png",
    "jpg",
    "jpeg",
    "bmp",
    "gif",
    "pdf",
    "msg",
    "eml",
    "doc",
    "docx",
    "ppt",
    "pptx",
    "xls",
    "xlsx",
    "csv",
    "rtf",
    "odp",
    "odt",
    "ods",
    "txt",
    "wks",
    "zip"
  ]
}
Send exactly one complete, nonempty multipart/form-data file part named file. The supported extensions and current per-file limit are shown below; the complete request limit also includes multipart overhead. A missing or null file is invalid and does not remove an existing invoice.
Idempotency-Key String No
A unique key for safely retrying this upload.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.

Good to know

Adds one Invoice Attachment to this Attendee / Registration. You can attach an invoice, receipt or other payment document when no invoice file is currently attached.

Before you upload

POST requires an empty invoice slot. If an invoice is already attached, the API returns HTTP 409; use PATCH to replace it.

An Invoice Attachment is separate from the record's supporting File Attachments. Use the invoice control beside the Attendee / Registration record's cost and payment details in the web app.

After the upload

The response's invoice_attachment contains the attached file's id, filename and attachment_created_timestamp. The amount, payment fields, cost-center breakdown and other files are unchanged.

The upload is recorded in Event history. Attaching an invoice does not mark the record as paid.

Access and retries

A current upload-enabled plan, record and financial permissions, and an editable applicable tab are required. Each uploaded file must fit its supported type and size limits.

expected_revision is not supported by this file method. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/staff/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Staff tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/events/staff/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "staff_entry_id=12345" --form "file=@invoice.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

{
  "invoice_attachment": {
    "id": 12345,
    "filename": "invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  }
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Replace Attendee / Registration Invoice Attachment #

Method
PATCH
Endpoint

Replaces an Attendee / Registration's Invoice Attachment.

Parameters
Name Type Required? Description Details
staff_entry_id Number Yes
The ID of the Attendee / Registration record, from Retrieve Attendees / Registrations (GET /v1/events/staff) or its add response.
file File (multipart) Yes
The Invoice Attachment to upload.

Maximum size per file: 25 MiB (26,214,400 bytes).

Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip.

Maximum files per request: 1.

View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "string",
  "format": "binary",
  "x-maximum-bytes": 26214400,
  "x-allowed-extensions": [
    "png",
    "jpg",
    "jpeg",
    "bmp",
    "gif",
    "pdf",
    "msg",
    "eml",
    "doc",
    "docx",
    "ppt",
    "pptx",
    "xls",
    "xlsx",
    "csv",
    "rtf",
    "odp",
    "odt",
    "ods",
    "txt",
    "wks",
    "zip"
  ]
}
Send exactly one complete, nonempty multipart/form-data file part named file. The supported extensions and current per-file limit are shown below; the complete request limit also includes multipart overhead. A missing or null file is invalid and does not remove an existing invoice.

Good to know

Replaces this Attendee / Registration's current Invoice Attachment with one uploaded file. Use this method when an invoice file is already attached.

Replacing the current file

PATCH requires a current invoice file. If none is attached, the API returns HTTP 404. Upload exactly one file; the previous attachment ID is not needed.

If another request changes the current invoice during your upload, the API refuses this request instead of replacing a different file. Even identical replacement contents receive a new attachment ID.

After the replacement

The response's invoice_attachment contains the attached file's id, filename and attachment_created_timestamp. The amount, payment fields, cost-center breakdown and other files are unchanged.

The previous file is scheduled for physical cleanup after a confirmed save; cleanup may finish later. The replacement is recorded in Event history.

Access and retries

A current upload-enabled plan, record and financial permissions, and an editable applicable tab are required. Each uploaded file must fit its supported type and size limits.

expected_revision is not supported by this file method. PATCH does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/staff/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Staff tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X PATCH "https://api.exhibitday.com/v1/events/staff/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "staff_entry_id=12345" --form "file=@invoice.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

{
  "invoice_attachment": {
    "id": 12345,
    "filename": "invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  }
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Remove Attendee / Registration Invoice Attachment #

Method
DELETE
Endpoint

Deletes an Attendee / Registration's Invoice Attachment.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
staff_entry_id Number Yes
The ID of the Attendee / Registration record, from Retrieve Attendees / Registrations (GET /v1/events/staff) or its add response.

Good to know

Removes this Attendee / Registration's Invoice Attachment. The cost, payment details and other File Attachments stay in place.

After the removal

The Invoice Attachment is cleared and the removal is recorded in Event history. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Costs, payment fields, cost-center allocations and supporting files stay unchanged.

If no invoice is attached, DELETE returns HTTP 404 Not Found with the message "This Attendee / Registration has no invoice to remove." No saved data or history is changed. Current access and the record's binding are still checked. Do not send file parts with this request.

Access and retries

Current record, financial and invoice permissions and applicable tab-edit access are required. Permitted removals remain available on the Free plan.

expected_revision is not supported, and DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/staff/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Staff tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/staff/invoice_attachment?staff_entry_id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Attachment removed.",
  "errors": []
}

Retrieve Attendee / Registration General File Attachments #

Method
GET
Endpoint

Retrieves the General File Attachments on an Attendee / Registration.

Parameters
Name Type Required? Description Details
staff_entry_id Number Yes
The ID of the Attendee / Registration record, from Retrieve Attendees / Registrations (GET /v1/events/staff) or its add response.
$limit Number No
The most File Attachments to return.
A positive whole number. Omit for all remaining matching files.
$offset Number No
The number of matching File Attachments to skip.
A whole number of 0 or more. Default: 0.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records.
Allowed values: array
If-None-Match String No
An ETag from an earlier response to this GET.
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.

Good to know

Retrieves the General File Attachments on this Attendee / Registration. Each result includes the file's ID, name and added time; use the download method for its contents.

Reading the file list

Files are ordered by added time, then attachment ID, lowest first. Only files available under your current access are included.

Paging totals and X-Total-Count count all matching files before $limit and $offset are applied. A record with no files you can view returns an empty list. This list does not return edit revisions or support changed-since filtering.

Supporting files and invoices

These are the record's General File Attachments. Its cost Invoice Attachment is separate and has its own download and upload methods. Use this list's id values for these supporting-file downloads and removals.

Access

The record's Event and tab must be available, and the tab must not be hidden. A locked tab can still be read.

Hidden tab

If the Event's Staff tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/staff/attachments?staff_entry_id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "attachment",
  "list_data": [
    {
      "id": 12345,
      "filename": "attachment.pdf",
      "attachment_created_timestamp": "2027-01-30T12:00:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add Attendee / Registration General File Attachments #

Method
POST
Endpoint

Adds General File Attachments to an Attendee / Registration.

Parameters
Name Type Required? Description Details
staff_entry_id Number Yes
The ID of the Attendee / Registration record, from Retrieve Attendees / Registrations (GET /v1/events/staff) or its add response.
file File (multipart) Yes
The File Attachments to upload.

Maximum size per file: 25 MiB (26,214,400 bytes).

Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip.

View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "array",
  "items": {
    "type": "string",
    "format": "binary",
    "x-maximum-bytes": 26214400,
    "x-allowed-extensions": [
      "png",
      "jpg",
      "jpeg",
      "bmp",
      "gif",
      "pdf",
      "msg",
      "eml",
      "doc",
      "docx",
      "ppt",
      "pptx",
      "xls",
      "xlsx",
      "csv",
      "rtf",
      "odp",
      "odt",
      "ods",
      "txt",
      "wks",
      "zip"
    ]
  }
}
Send one or more complete, nonempty multipart/form-data parts, each named file. Supported types and the current per-file limit are shown below. The complete request limit includes all files and multipart overhead; split larger batches. A missing or null upload is not a removal request.
Idempotency-Key String No
A unique key for safely retrying this upload.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.

Good to know

Adds one or more General File Attachments to this Attendee / Registration. Send each file as a multipart upload part named file.

After the upload

The response's list_data contains the newly attached files, including each id, filename and attachment_created_timestamp. Existing files are kept. Use each returned id to download or remove that file.

Identical repeated files in one request are attached once when their cleaned filename, length and contents match. Files with different contents remain separate even when their names match. This does not remove or replace files already attached to the record.

Choosing the right file method

These uploads add General File Attachments. Use this record's Invoice Attachment methods for its cost invoice or receipt. Adding supporting files does not change amounts, payments or cost-center allocations.

Access

Current record and file-change permissions and applicable Event/tab locks must allow this upload. An upload-enabled paid plan is required.

History and retries

A confirmed file change is recorded in history. expected_revision is not supported by these file methods. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.

Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.

Hidden or locked tab

If the Event's Staff tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/events/staff/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "staff_entry_id=12345" --form "file=@attachment.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "attachment",
  "list_data": [
    {
      "id": 12345,
      "filename": "attachment.pdf",
      "attachment_created_timestamp": "2027-01-30T12:00:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Remove an Attendee / Registration General File Attachment #

Method
DELETE
Endpoint

Deletes a General File Attachment from an Attendee / Registration.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the File Attachment.
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.

Good to know

Removes one General File Attachment from this Attendee / Registration. Other attached files and the record's details stay in place.

After the removal

Only the selected file association is removed. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Other attached files stay in place.

Send only the file's id; the API finds the record it belongs to. A missing, already removed or unavailable attachment returns HTTP 404 Not Found. Do not send file parts with DELETE.

Access

Current record and file-removal permissions and applicable Event/tab locks must allow this change. Permitted removals remain available on the Free plan.

History and retries

A confirmed file change is recorded in history. expected_revision is not supported by these file methods. DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.

Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.

Hidden or locked tab

If the Event's Staff tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/staff/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Attachment removed.",
  "errors": []
}

Download an Attendee / Registration General File Attachment #

Method
GET
Endpoint

Downloads a General File Attachment from an Attendee / Registration.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the File Attachment.
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.

Good to know

Downloads one original General File Attachment from this Attendee / Registration. Select the file using its ID from the attachment list.

Download response

A successful response contains the original uploaded file with a safe download filename. API errors use the usual JSON response. A missing or unavailable file returns HTTP 404.

Send only the file's id from the attachment list to download that one file; the API finds the record it belongs to. The download leaves the record unchanged.

Access

The record's Event and tab must be available, and the tab must not be hidden. A locked tab can still be read.

Files still being copied

If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.

Hidden tab

If the Event's Staff tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

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/staff/attachments/download?id=12345" -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 'attachment.pdf'

Example response

File: attachment.pdf
Content type: application/octet-stream
Note: The response body contains file bytes.