Home

Download this help site
(PDF 82MB)

Download

Wild Apricot API Version 1

Icon

Wild Apricot will be discontinuing Version 1 of our API as of November 1, 2017. All Version 1 functionality is available in Version 2 of our API. For information on transitioning from Version 1 to Version 2, click here.

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 data from 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.

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. Not a programmer? You can use the supplied Excel file to download contact records right away – no programming required.

Wild Apricot API calls

Wild Apricot API calls can be used to retrieve the following information from your Wild Apricot database.

Results

For more information, see...

A list of API versions

Base API call

A list of top-level API calls for a particular version

Base API call

Details about your Wild Apricot account

Accounts API V1 call

Details about your membership levels

MembershipLevels API V1 call

Details about a particular membership level

MembershipLevels API V1 call

Detailed list of common, membership, and system fields

ContactFields API V1 call

Detailed list of contacts

Contacts API V1 call, Downloading contact records using the sample Excel file

Details about a particular contact

Contacts API V1 call

To see how Wild Apricot's API works without having to write any code, you can use Wild Apricot's API V1 browser, a JavaScript application embedded in a help topic.

Using Wild Apricot's API

Wild Apricot's API is a server-side implementation that adheres to RESTful web service principles. The API can be accessed from a 3rd-party server or application. It is not designed for client-side calls. You cannot, for example, embed code in your Wild Apricot site to retrieve information from your Wild Apricot database. For information on differences between the two, see API access options.

Version 1 API calls take the form of HTML GET requests formatted in either JSON (JavaScript Object Notation) or XML (Extensible Markup Language). You can program the API calls using any programming
language you choose, including C#, Visual Basic, and PHP.

Secure access

The Wild Apricot API supports only encrypted HTTP requests – ones that begin with https. Insecure requests – ones that begin with http – are not supported.

Authentication

Each Wild Apricot API call must include authentication information that  verifies  your account and prevents others from accessing your data. The required authentication information – and how it is passed – differs depending on whether you are accessing the API from a 3rd party server or application, or from a Wild Apricot site page. For information on authenticating server-side access, see  Authenticating API access from a 3rd-party server or application . 

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 v1 value directs the call to version 1 of the Wild Apricot API.

A call to the base API – https://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.

 

 

 

  • No labels