⚠️
Two versions are available for Registration end-points. We recommend adopting version 2 which has improved filtering and data.

All of the details captured on registrants through registration forms on the Events Platform can be found in the Registrations endpoints. This includes their contact details, merchandise choices and any custom questions included in the registration forms.

The following table contains the fields that are returned within the response call of the registration endpoints.

The first table contains the fields within the response while the others breakdown the next objects within the response.

Key	Label	Type	Description	Version
account_guid	Account GUID	UUID	Account GUID	All
address_line_one	Address Line One	String	First line of address for registrant	All
address_line_two	Address Line Two	String	Second line of address for registrant	All
campaign_guid	Campaign GUID	UUID	Campaign GUID	V1 only
changed_at	Changed At	Date	Date registrant’s information updated	All
city	City	String	City of registrant	All
country	Country	String	Country of registrant	All
county	County	String	County of registrant	All
discount_code	Discount Code	String	Discount code	All
discount_id	Discount Id	String	Discount Id	All
dob	Date of Birth	Date	Date of birth of registrant	All
donation	Donation	Donation	Donation object	All
email	Email	String	Email of registrant	All
event_guid	Event GUID	UUID	Event GUID	All
event_name	Event Name	String	Name of event	All
first_name	First Name	String	First name of registrant	All
fitness_guid	Fitness GUID	UUID	Fitness GUID	V1 only
fitness_settings_guid	Fitness Settings GUID	UUID	Fitness Settings GUID	V1 only
fundraising	Fundraising	Fundraising	Fundraising Object	All
fundraising_guid	Fundraising GUID	UUID	Fundraising GUID	V1 only
gender	Gender	String	Gender of registrant	All
last_name	Last Name	String	Last name of registrant	All
manage_my_reg_url	Manage My Regisration URL	String	URL for managing your registration	All
merchandise	Merchandise	Merchandise	Merchandise object	All
meta_data	Meta Data	Array[string]	Contains an array, each element has a key (string) and value (string)	All
method	Method	String	Registration method	All
order_id	Order Id	Long	Order Id	All
payment	Payment	Payment	Payment object	V1 only
payment_guid	Payment GUID	UUID	Payment GUID	All
phone	Phone	String	Phone number of registrant	All
post_code	Post Code	String	Post code of registrant	All
primary	Primary	Boolean	Primary registration	All
questions	Questions	List	List of question objects	All
registration_date	Registration Date	Date	Registration date	All
registration_guid	Registration GUID	UUID	Registration GUID	All
status	Status	String	Registration status, values can be: -Cancelled -Completed -Deleted -Deferred -Staged -WaitingList	All
team	Team	Team	Team object	All
ticket	Ticket	Ticket	Ticket object	All

💳 Donation Object

Key	Label	Type	Description	Version
donation_amount	Donation Amount	Long	Donation amount	All
donation_id	Donation Id	Long	Donation Id	All

💫 Fundraising Object

Key	Label	Type	Description	Version
campaign_guid	Campaign GUID	UUID	Campaign GUID	V1 only
page_id	Page Id	Long	Page Id	All

👕 Merchandise Object

Key	Label	Type	Description	Version
merchandise_id	Merchandise Id	Long	Merchandise Id	All
merchandise_item	Merchandise Item	String	Merchandise item within merchandise object	All
merchandise_item_id	Merchandise Item Id	Long	Merchandise Item Id	All
merchandise_name	Merchandise Name	String	Name of merchandise	All
payment	Payment	Payment	Payment for merchandise	V1 only
price	Price	Long	Price of merchandise	All

💳 Merchandise Payment Object

				Version
campaign_guid	Campaign GUID	UUID	Campaign GUID	V1 only
payment_guid	Payment GUID	UUID	Payment GUID	V1 only
registration_guid	Registration GUID	UUID	Registration GUID	V1 only

❓ Questions Object

Key	Label	Type	Description	Version
additional_fee	Additional Fee	Long	Additional fee	All
alias	Alias	String	Question alias	All
question_id	Question Id	Long	Question Id	All
response	Response	String	Answer to question	All
tag_id	Tag Id	Long	Tag Id	All

👪 Team Object

Key	Label	Type	Description	Version
team_fundraising_guid	Team Fundraising GUID	UUID	Team Fundraising GUID	All
team_guid	Team GUID	UUID	Team GUID	All
team_id	Team Id	Long	Team Id	All
team_name	Team Name	String	Name of team	All
team_page	Team Page	String	Page associated with team	All
team_payment_guid	Team Payment GUID	UUID	Team Payment GUID	All

🎟️ Ticket Object

Key	Label	Type	Description	Version
description	Description	String	Description of ticket	All
price	Price	Long	Price of ticket	All
service_fee	Service Fee	Long	Service fee for ticket	All
ticket_name	Ticket name	String	Name of ticket	All
ticket_type	Ticket Type	String	Type ticket, values can be: -Individual -Group	All

🚀 Return a list of registrations

/registrations
Returns a list of registrations within your account filterable by the attributes below.

Key	Label	Type	Description	Version
campaign_guids	Campaign Guids	Array[string]	Campaign GUID associated with the registration object	V1 only
date_from	Date From	String	Date from which to filter based on the created date of the registration object	V1 only
date_to	Date To	String	Date to filter to based on the created date of the registration object	V1 only
entry_status	Entry Status	String	Status of registration, values can be: -CANCELLED -COMPLETED -DELETED -STAGED -WAITINGLIST	All
new_registrations_only	New Registrations Only	Boolean	Filter response to only include new registrations. If true is selected at least one data field must be used to filter new_registrations either to or from.	V1 only
limit	Limit	Integer	Number of records to be returned in the response	All
order_by	Order By	String	Used to order the response by chosen value, values can be: -FIRSTNAME -LASTNAME -(Default) REGISTRATIONUPDATEDAT	All
page	Page	Integer	The number of pages to skip before starting to collect the result set	All
search	Search	String	String to search by `first_name` and `last_name`	All

Sample Request

GET - http://dataapi.enthuse.com/registrations/?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc
&campaign_guids=00000000-0000-0000-0000-000000000000
&new_registrations_only=true
&date_from=2020-02-25%2000%3A00%3A00
&date_to=2020-03-01%2000%3A00%3A00
&limit=25
&page=1
&entry_status=COMPLETED

Sample Responses:

200 - OK call was successful and returned data

{
  "message": "string",
  "registrationList": [
    {
      "account_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "address_line_one": "string",
      "address_line_two": "string",
      "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "changed_at": "2020-01-01 00:00:00",
      "city": "string",
      "country": "string",
      "county": "string",
      "discount_code": "string",
      "discount_id": 0,
      "dob": "2020-01-01",
      "donation": {
        "donation_amount": 0,
        "donation_id": 0
      },
      "email": "string",
      "event_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "event_name": "string",
      "first_name": "string",
      "fitness_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "fitness_settings_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "fundraising": {
        "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "page_id": 0
      },
      "fundraising_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "gender": "string",
      "last_name": "string",
      "manage_my_reg_url": "string",
      "merchandise": [
        {
          "merchandise_id": 0,
          "merchandise_item": "string",
          "merchandise_item_id": 0,
          "merchandise_name": "string",
          "payment": [
            {
              "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
              "payment_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
              "registration_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
            }
          ],
          "price": 0
        }
      ],
      "meta_data": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "method": "string",
      "order_id": 0,
      "payment": {
        "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "payment_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "registration_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
      },
      "payment_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "phone": "string",
      "post_code": "string",
      "primary": true,
      "questions": [
        {
          "additional_fee": 0,
          "alias": "string",
          "question_id": 0,
          "response": "string",
          "tag_id": 0
        }
      ],
      "registration_date": "2020-01-01 00:00:00",
      "registration_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "status": "string",
      "team": {
        "team_fundraising_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "team_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "team_id": 0,
        "team_name": "string",
        "team_page": "string",
        "team_payment_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
      },
      "ticket": {
        "description": "string",
        "price": 0,
        "service_fee": 0,
        "ticket_id": 0,
        "ticket_name": "string",
        "ticket_type": "string"
      }
    }
  ],
  "status": 0
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authenticated by no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}

🚀 Retrieves an existing registration record

/registrations/{registration_guid}

Get a registration object filterable by the attribute below

Key	Label	Type	Description
registration_guid	Registration GUID	GUID	Registration GUID

Sample Request

GET - http://dataapi.enthuse.com/registrations/?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc&registration_guid=00000000-0000-0000-0000-000000000000

Sample Responses:

200 - OK call was successful and returned data

{
  "account_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "address_line_one": "string",
  "address_line_two": "string",
  "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "changed_at": "2020-01-01 00:00:00",
  "city": "string",
  "country": "string",
  "county": "string",
  "discount_code": "string",
  "discount_id": 0,
  "dob": "2020-01-01",
  "donation": {
    "donation_amount": 0,
    "donation_id": 0
  },
  "email": "string",
  "event_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "event_name": "string",
  "first_name": "string",
  "fitness_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "fitness_settings_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "fundraising": {
    "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "page_id": 0
  },
  "fundraising_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "gender": "string",
  "last_name": "string",
  "manage_my_reg_url": "string",
  "merchandise": [
    {
      "merchandise_id": 0,
      "merchandise_item": "string",
      "merchandise_item_id": 0,
      "merchandise_name": "string",
      "payment": [
        {
          "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "payment_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "registration_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
        }
      ],
      "price": 0
    }
  ],
  "meta_data": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "method": "string",
  "order_id": 0,
  "payment": {
    "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "payment_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "registration_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
  },
  "payment_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "phone": "string",
  "post_code": "string",
  "primary": true,
  "questions": [
    {
      "additional_fee": 0,
      "alias": "string",
      "question_id": 0,
      "response": "string",
      "tag_id": 0
    }
  ],
  "registration_date": "2020-01-01 00:00:00",
  "registration_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "status": "string",
  "team": {
    "team_fundraising_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "team_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "team_id": 0,
    "team_name": "string",
    "team_page": "string",
    "team_payment_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
  },
  "ticket": {
    "description": "string",
    "price": 0,
    "service_fee": 0,
    "ticket_id": 0,
    "ticket_name": "string",
    "ticket_type": "string"
  }
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - The account linked to the token does not match

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authenticated but no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}