Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WildApricot Events API

Event and registration management

WildApricot Events API is one of 29 APIs that WildApricot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 6 operations across 3 paths, and defines 34 schemas. It is described by OpenAPI 3.0.3, at version 7.24.0.

Requests are made against a single base URL, https://api.wildapricot.org/v2.2.

6 operations 3 paths 34 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.24.0
Base URL
https://api.wildapricot.org/v2.2
Authentication
OAuth 2.0
License
Proprietary
Resource Areas
1

Authentication & Security 1

WildApricot Events API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 1 scope.

  • OAuth2 — OAuth2 authentication for WildApricot API

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Events 6

Event and registration management

GET
/accounts/{accountId}/events
WildApricot Events List
GetEventsList 9 params → 200400401429
POST
/accounts/{accountId}/events
WildApricot Create a New Event Record
CreateEvent 1 param body → 200400401429
GET
/accounts/{accountId}/events/{eventId}
WildApricot Retrieve Information About Specific Event
GetEventDetails 2 params → 200401404429
PUT
/accounts/{accountId}/events/{eventId}
WildApricot Update Information About Existing Event
UpdateEvent 2 params body → 200401404429
DELETE
/accounts/{accountId}/events/{eventId}
WildApricot Completely Delete Event from System.
DeleteEvent 2 params → 200401404429
POST
/rpc/{accountId}/CloneEvent
WildApricot Clone Existed Event.
CloneEvent 2 params → 200400

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are EventRegistrationType (21 properties), Event (20 properties), EventDetails (18 properties), EventDetailsEditParams (14 properties). Each schema is shown below with its type and property counts.

EventGuestRegistrationPolicy
string
Describes how guests are registered. Allowed values are - Disabled - guest registration is not allowed - NumberOfGuests - number of guests should be specified.…
EventInviteeStatistics
object
Statistics related to invitees to RSVP events.
4 properties
EditEntityFieldParams
EventIdsResponse
object
1 property
ResourceUrl
string
Permanent resource URL in API.
Event
object
20 properties 5 required
EventWaitlistSettings
object
2 properties
EventRegistrationUnavailabilityPolicy
string
Indicates what is displayed if the registration type is not available for a particular visitor.
EventAccessControl
object
Describes event availability.
5 properties 1 required
EventAttendeesDisplaySettings
object
Settings for section "List of event registrants" on UI.
2 properties
EventRegistrationTypeAvailability
string
Indicates who the registration type is available to.
Error
object
3 properties 2 required
EventPaymentMethodType
string
How attendees can pay for the ticket. - OnlineAndOffline - OfflineOnly - OnlineOnly
EntityFieldDescription
object
9 properties 3 required
LinkedResource
object
2 properties
EventRegistrationFieldDescription
CustomFieldType
string
Custom field data type.
EventEditParams
object
13 properties 3 required
ContactFieldAccessLevel
string
Indicates who is allowed to view the field value. - Public - value is visible to anyone who has access to members directory - Members - value is visible only t…
RulesAndTermsInfo
object
Additional info for fields with rules / terms conditions. Not present for other field types.
2 properties
OptionsListItem
object
5 properties
EventAccessLevel
string
Event accessability. - Public means event accessible for everyone - AdminOnly means event accessible for administrators only - Restricted means event accessibl…
EventDetailsEditParams
object
14 properties
EventsResponse
EventSesssion
object
6 properties
EventGuestRegistrationSettings
object
Control how system works with guest registrations for specific event.
2 properties
ExtraCharge
object
This property appears for CalculatedExtraCharge fields only.
6 properties 2 required
EventRegistrationCancellationBehavior
string
Indicates if it is possible for attendee to self-cancel event registration.
EventRegistrationType
object
21 properties
EventDetails
object
18 properties
TimeZone
object
Details about account time zone
3 properties
EventsCountResponse
object
1 property
EntityFieldDescriptionWithExtraCharge
EventsListResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wildapricot-events-api-openapi.yml Raw ↑

Other APIs WildApricot publishes across the network.

WildApricot Accounts API
WildApricot Attachments API
WildApricot Contacts API
WildApricot Contacts.CustomFields API
WildApricot Contacts.SavedSearch API
WildApricot Donation.CustomFields API
WildApricot Emailing.Drafts API
WildApricot Emailing.Operations API
WildApricot Emailing.SentEmailRecipients API
WildApricot Emailing.SentEmails API
WildApricot Events.EventRegistrations API
WildApricot Events.EventRegistrationTypes API