GET api/v2.0/Events/GetEventRegistrants?calendarEventKey={calendarEventKey}&modifiedDateTime={modifiedDateTime}&maxRecords={maxRecords}&continuationToken={continuationToken}

Administrator-accessible only endpoint. Returns Paged Registrant Data for a given Calendar Event.

Request Information

URI Parameters

Name	Description	Type	Additional information
calendarEventKey	Required. Unique Identifier for a Calendar Event.	globally unique identifier	Required
modifiedDateTime	Optional. The format is "yyyy-MM-ddTHH:mm:ss". If specified only registrant records that have been modified on or after this date will be returned.	date	None.
maxRecords	The maximum number of records to return. Defaults to 50 if not specified.	integer	Default value is 50
continuationToken	The last RegistrantKey seen. If not provided, will start at the first Registrant record for the Event. The Registrants are sorted by a SQL Guid sort order.	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of Event Registrants for the provided CalendarEventKey.

Collection of EventRegistrantConcise

Name	Description	Type	Additional information
RegistrantKey	Unique Key for the Registrant.	globally unique identifier	None.
BadgeName	Name to display on the Registrant's Badge.	string	None.
FirstName	First Name of the Registrant.	string	None.
LastName	Last Name of the Registrant.	string	None.
Email	Email Address from the Registrant record.	string	None.
CompanyName	Company Name from the Registrant record.	string	None.
CompanyTitle	Company Title from the Registrant record.	string	None.
WebsiteUrl	Registrant's Website URL - if specified.	string	None.
PictureUrl	Registrant's Picture URL.	string	None.
LargePictureUrl	Registrant's Large Picture URL.	string	None.
DirectoryOptOut	Is this Registrant opting out of the Directory?	boolean	None.
ContactMeOptOut	Is this Registrant opting out of being Contacted?	boolean	None.
RegistrationKey	The RegistrationKey associated with this Registrant.	globally unique identifier	None.
ContactKey	The System ContactKey for this Registrant.	globally unique identifier	None.
UpdatedOn	The Last Updated Date for this Registrant. This is the MAX value of: Registrant.UpdatedOn, Registration.UpdatedOn and any Event Option's UpdatedOn Date.	date	None.
RegistrantClass	The Class or Type of Registrant.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "RegistrantKey": "2f48ce59-419e-4792-8fff-943e5dc7e758",
    "BadgeName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Email": "sample string 5",
    "CompanyName": "sample string 6",
    "CompanyTitle": "sample string 7",
    "WebsiteUrl": "sample string 8",
    "PictureUrl": "sample string 9",
    "LargePictureUrl": "sample string 10",
    "DirectoryOptOut": true,
    "ContactMeOptOut": true,
    "RegistrationKey": "fbb79f4b-92b1-4647-b7dc-930f9f53a7a3",
    "ContactKey": "cf153717-6da1-4ddc-8941-558883cd863d",
    "UpdatedOn": "2024-10-07T13:44:21.959982Z",
    "RegistrantClass": "sample string 16"
  },
  {
    "RegistrantKey": "2f48ce59-419e-4792-8fff-943e5dc7e758",
    "BadgeName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Email": "sample string 5",
    "CompanyName": "sample string 6",
    "CompanyTitle": "sample string 7",
    "WebsiteUrl": "sample string 8",
    "PictureUrl": "sample string 9",
    "LargePictureUrl": "sample string 10",
    "DirectoryOptOut": true,
    "ContactMeOptOut": true,
    "RegistrationKey": "fbb79f4b-92b1-4647-b7dc-930f9f53a7a3",
    "ContactKey": "cf153717-6da1-4ddc-8941-558883cd863d",
    "UpdatedOn": "2024-10-07T13:44:21.959982Z",
    "RegistrantClass": "sample string 16"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEventRegistrantConcise xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Events">
  <EventRegistrantConcise>
    <BadgeName>sample string 2</BadgeName>
    <CompanyName>sample string 6</CompanyName>
    <CompanyTitle>sample string 7</CompanyTitle>
    <ContactMeOptOut>true</ContactMeOptOut>
    <DirectoryOptOut>true</DirectoryOptOut>
    <Email>sample string 5</Email>
    <FirstName>sample string 3</FirstName>
    <LargePictureUrl>sample string 10</LargePictureUrl>
    <LastName>sample string 4</LastName>
    <PictureUrl>sample string 9</PictureUrl>
    <RegistrantClass>sample string 16</RegistrantClass>
    <RegistrantKey>2f48ce59-419e-4792-8fff-943e5dc7e758</RegistrantKey>
    <WebsiteUrl>sample string 8</WebsiteUrl>
  </EventRegistrantConcise>
  <EventRegistrantConcise>
    <BadgeName>sample string 2</BadgeName>
    <CompanyName>sample string 6</CompanyName>
    <CompanyTitle>sample string 7</CompanyTitle>
    <ContactMeOptOut>true</ContactMeOptOut>
    <DirectoryOptOut>true</DirectoryOptOut>
    <Email>sample string 5</Email>
    <FirstName>sample string 3</FirstName>
    <LargePictureUrl>sample string 10</LargePictureUrl>
    <LastName>sample string 4</LastName>
    <PictureUrl>sample string 9</PictureUrl>
    <RegistrantClass>sample string 16</RegistrantClass>
    <RegistrantKey>2f48ce59-419e-4792-8fff-943e5dc7e758</RegistrantKey>
    <WebsiteUrl>sample string 8</WebsiteUrl>
  </EventRegistrantConcise>
</ArrayOfEventRegistrantConcise>