Home

Download this help site
(PDF 80MB)

Download

Base API V1 call

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.

You can use the base API call to retrieve a list of API versions, or the next level of API calls for a particular version.

Retrieving a list of API versions

Calling the base API without specifying any further parameters will return a list of available API versions.

Syntax

where {APIkey} is a string of characters used to authenticate your account and prevent others from accessing your data. You can get your API key by clicking the API key link from the Settings screen. The API key can be passed as a URL parameter or as a HTTP header field.

Example:

Response fields

For each API version, the base API call retrieves the following information.

Field

Description

Version

The version number of the API.

Name

The full name of the API version.

URL

The URL of the API version. This address is the same as the call used to display a list of API calls for this version.

Deprecated

Indicates whether this version has been superseded by a newer version. Possible values are true and false.

Sample JSON response

Sample XML response

Retrieving API calls for a particular version

If you add the version number to the base API call, a list of top-level API calls will be returned.

Icon

A number of other API calls may be subordinate to the top-level call(s). For example, the MembershipLevels, ContactFields, and Contacts API calls are grouped under the Accounts API V1 call.

Syntax

Example:

Parameters

The following parameters are used within the base API call to retrieve a list of API calls for a particular version of the API:

Parameter

Description

{version}

The version number of the API. You can retrieve a list of API version by calling the base API without specifying a version.

{APIkey}

String of characters used to authenticate your account and prevent others from accessing your data. You can get your API key by clicking the API key link from the Settings screen. The API key can be passed as a URL parameter or as a HTTP header field.

Response fields

For each API call, the base API call retrieves the following information.

Field

Description

Name

The full name of the API call.

URL

The URL of the API call. To view API calls nested under the returned call, run the URL.

Sample JSON response

Sample XML response

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