Added
V2 Registration endpoint: New data and filtering
November 1st, 2024
We have introduced a V2 Registration API endpoint on the November 1st 2024.
The following data is now available in RegistrationV2:
| New Data | Description |
|---|---|
| updated_at | Tracks the last modified date of a registration, ensuring access to the most current information. |
| event_type | Provides the string name of the event type used for the registration form. This will provide visibility to those charities who use custom event types for reporting and attribution purposes via the API |
| mobile | Provides access to the system default field of "Phone2" labelled as "Mobile phone" in registration forms. This can be used alongside the existing "Phone" field to give full accessibility to system default fields. |
These enhancements will improve the data we are able to offer and increase flexibility in how we manage and deliver information to you. Find out more in our developer centre here.
The following new filtering options are available in RegistrationV2:
| New Filter | Description |
|---|---|
| updated_at_from updated_at_to | Explicit date filtering by updated_at to improve ease and robustness. |
| event_type | Allows filtering based on a specific Event Type based on the string name visible in the back-office |
| event_guid | Allow filtering by a specific event GUID which replaces the campaign GUID for more robust usage |
| payment_guid | Allow filtering by a specific payment GUID to facilitate new use cases |
The following aspects have been removed from V2 but remain available in V1:
| Deprecated | Type | Description |
|---|---|---|
| campaign_guids | Filter | Campaign endpoint is marked for deprecation and has been removed from the developer centre due to issues with data quality and clarity. event_guid replaces this aspect with the Event fundraising pages endpoint |
| date_from date_to | Filter | Replaced with explicit updated_at to improve clarity and usability |
| new_registrations_only | Filter | Removed due to the removal of date_from and date_to with explicit updated_at to improve clarity and usability |
| fitness_guid | data | Removed as the data has not value or use. |
| fitness_settings_guid | data | Removed as the data has not value or use. |
| campaign_guid | data | Campaign endpoint is marked for deprecation and has been removed from the developer centre due to issues with data quality and clarity. event_guid replaces this aspect with the Event fundraising pages endpoint |
| fundraising_guid | data | Removed as the data has not value or use. |
| fundraising.campaign_guid | data | Campaign endpoint is marked for deprecation and has been removed from the developer centre due to issues with data quality and clarity. event_guid replaces this aspect with the Event fundraising pages endpoint |
| payment.registration_guid | data | Duplicated value. Data remains accessible viaregistration_guid |
| payment.payment_guid | data | Duplicated value. Data remains accessible via payment_guid |
| payment.campaign_guid | data | Campaign endpoint is marked for deprecation and has been removed from the developer centre due to issues with data quality and clarity. event_guid replaces this aspect with the Event fundraising pages endpoint |
| merchandise.payment | data | Duplicated values. Data remains accessible via` registration_guid and payment_guid |
V1 registration end point will remain available to ensure you still can access the current data you need as part of your registration journey.