Home

Download this help site
(PDF 82MB)

Download

EventRegistrations API V2 call

Icon

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

You can use the EventRegistrations API call to retrieve a list of event registrations for a particular event or contact, and to retrieve details for a particular registration. You can also add, update, or delete event registrations using this API call.

Icon

You can use the EventRegistrations API to migrate old event registrations to your Wild Apricot database.

Retrieving registrations for a particular contact

Syntax

Example

Retrieving registrations for a particular event

Syntax

Example

Icon

You can specify both a contact and an event – e.g. ?contactId=725295&eventId=11769 – to further narrow the results.

Retrieving specific registrations

You can filter the registrations returned by the EventRegistrations API call by specifying a list of registration IDs. Only registrations with the specified IDs will be retrieved.

Syntax

Example

Retrieving event registration details

Syntax

Example:

Parameters

The following parameters are used within the EventRegistrations API call:

Variable

Description

{baseAPIaddress}

The base address of the API. For more information, see API access options.

{accountID}

The account identifier that appears on the Account and billing screen and is returned by the Accounts API call.

{contactID}The unique identifier for a contact. Contacts IDs are returned by the Contacts API call.
{eventID}The unique identifier of an event. Event IDs are returned by the Events API call.
{eventRegistrationID}The unique identifier of an event registration. Event registration IDs are returned by the EventRegistrations API call.
Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

Response fields

For each invoice, the EventRegistrations API call retrieves the following information.

Field

Description

IDThe unique identifier of the event registration.
URLThe address of the URL call for the event registration.
EventThe start date, ID, URL, and name of the event.
ContactThe ID and URL of the registrant.
IsCheckedInIndicates whether the registrant has been checked in to the event.
RegistrationFeeThe fee for the registration.
PaidSumThe amount paid towards the registration fee.
InvoiceThe ID and URL of the invoice for the registration.
RegistrationTypeIDThe ID of the registration type.
IsPaidIndicates whether the registration has a status of Paid.
RegistrationFieldsThe name and value of the fields appearing on the registration form for this registration. To identify the field, you can use FieldName or SystemCode. SystemCode is a unique field identifier and can be used instead of FieldName for more accurate field identification. If both FieldName and SystemCode are defined, the field will be searched first by SystemCode and then by FieldName, (where there are no fields with the specified SystemCode). If only FieldName is defined and there are two fields that use it – system and custom – then only the system field will be updated.
ShowToPublicIndicates whether the registrant is included in the public list of event registrants.
RegistrationDateThe date of the registration.
MemoAny internal notes entered for the registration.
GuestRegistrationsSummary

A summary of guest registrations for this registration.

FieldDescription
NumberOfGuestsThe number of guests for this registration, if guest registrations are set up to collect only the total number of guests.
NumberOfGuestsCheckInThe number of guests under this registration who have been checked in, where guest registrations have been set up to collect only the total number of guests.
GuestRegistrationsThe contact ID and URL of each guest, if guest registrations are set up to collect contact information or full registration information for each guest.


IsGuestRegistrationIndicates whether the registration is a guest registration.
ParentRegistrationThe ID and URL of the parent registration. The value is NULL if registration is not a guest registration.

Sample JSON response

Sample XML response

Creating a new event registration

You can use an EventRegistrations API call to create a new event registration.

Syntax

Icon
  • The event registration ID should be 0 or should not be specified.
  • The following event registration fields are required: event ID, contact ID, RegistrationTypeID, and any required registration fields.
  • To identify the field, you can use FieldName or SystemCode. SystemCode is a unique field identifier and can be used instead of FieldName for more accurate field identification. If both FieldName and SystemCode are defined, the field will be searched first by SystemCode and then by FieldName, (where there are no fields with the specified SystemCode). If only FieldName is defined and there are two fields that use it – system and custom – then only the system field will be updated.
  • You can create the corresponding registration invoice by including a RecreateInvoice field and setting it to true .

Example

If any of the required fields are missing, or if any of the fields include invalid data, a  400 Bad Request  error will be returned. For more information, see API V2 status codes.

Updating an event registration

You can update an existing event registration using an EventRegistrations API call.

Syntax

Icon
  • The event registration ID must be specified both as a field and within the requesting URL. All other event registration fields are optional.
  • To identify the field, you can use FieldName or SystemCode. SystemCode is a unique field identifier and can be used instead of FieldName for more accurate field identification. If both FieldName and SystemCode are defined, the field will be searched first by SystemCode and then by FieldName, (where there are no fields with the specified SystemCode). If only FieldName is defined and there are two fields that use it – system and custom – then only the system field will be updated.
  • You can update the registration invoice to match the updated registration type and any extra cost options by including a RecreateInvoice field and setting it to true.

Example

Deleting an event registration

Syntax

Example

  • No labels