Home

Download this help site
(PDF 80MB)

Download

Wild Apricot API

Icon

Wild Apricot does not provide technical support for its API. If you encounter difficulties using it, add a post describing the issue to our Designers and Developers forum. Wild Apricot staff or other users may be able to suggest a solution.

Icon

By using Wild Apricot's API, you accept the API License Agreement.

About Wild Apricot's API

An API – Application Programming Interface – is a set of functions that allow programs to interact with each other. With Wild Apricot's API, you can create programs to automatically retrieve or update data stored in your Wild Apricot database. Version 1 of Wild Apricot's API can be used only to retrieve information, while Version 2 now provides the ability to update contact information, event registration, and payments, along with a number of new API calls you can use to retrieve additional information.

The retrieved data can be backed up, used to update another database, displayed on a web page, or passed onto another program for further processing or reporting.

The same application could retrieve data from an external database and use it to update your Wild Apricot database.

For example, you could use Wild Apricot's API to:

  • Create an Excel file that retrieves all your contacts with a single click and automatically generates a report or a chart.
  • Add code to a desktop database like Access or FileMaker that would regularly check your Wild Apricot account for new or updated records and automatically download them.
  • Automatically retrieve and store backup copies of your Wild Apricot contact database on a regular basis.
  • Develop your own website plugin to display a specially formatted list of your contacts – if Wild Apricot's member directory widget is not customizable enough for your needs.

Using Version 2 of the API, you could

  • Update Wild Apricot email preferences using an unsubscribe list maintained through an external email system.
  • Create and update payments in Wild Apricot using information stored in an external accounting system.

An API consists of a number of API calls, each of which performs a specific function. For example, Wild Apricot's MembershipLevels API call allows you to retrieve detailed information about your membership levels. As part of an API call, you can include parameters, which are instructions or information used by the API to process your request.

Icon

Using API calls to retrieve data from Wild Apricot databases requires significant programming knowledge. If you want to take advantage of this functionality but lack the technical knowledge, you can engage the services of an approved Wild Apricot partner.

Using Wild Apricot's API

Wild Apricot's API can be accessed from a 3rd-party server or application, or from a Wild Apricot site page. For information on differences between the two, see API access options.

Wild Apricot's API adheres to RESTful web service principles The API calls take the form of HTML GET, PUT, POST, or DELETE requests formatted in either JSON (JavaScript Object Notation) or XML (Extensible Markup Language).

Versioning

The version number of the Wild Apricot API is included in the API call to allow existing applications to function after new versions are released.

In the following example, the v2 value directs the call to version 2 of the Wild Apricot API.

A call to the base APIhttps://api.wildapricot.org – will return a list of available API versions.

Currently two version of the Wild Apricot API are available: Version 1 and Version 2. The process for authenticating accounts differs depending on the API version.

API responses

Results from Wild Apricot API calls can be returned in either JSON (JavaScript Object Notation) or XML (Extensible Markup Language) formats. The default format is JSON.

To specify the response format, include the following field in the HTTP header:

where {format} can be either json or xml.

You can compress the response by including the following field in the HTTP header:

For more information on compressing data in server responses, see HTTP compression.

API request limits

Currently, the limits on the number API request per minute are:

  • 20 requests involving multiple contacts
  • 60 requests involving single contacts
  • 200 other requests.

On this page:  

See also:

  • No labels
 
Wild Apricot Inc. 144 Front Street West Suite 725, Toronto, Ontario, Canada M5J 2L7