Home

Download this help site
(PDF 82MB)

Download

Base 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 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

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 API version, the base API call retrieves the following information.
FieldDescription
VersionThe version number of the API.
NameThe full name of the API version.
URLThe URL of the API version. This address is the same as the call used to display a list of API calls for this version.
DeprecatedIndicates whether this version has been superseded by a newer version and is therefore obsolete. 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

where {version} is the version number of the API.

Example

Icon
Each API call must include an authentication token that authenticates your account and prevents others from accessing your data. For more information, see API V2 authentication.

Response fields

For each API call, the base API call retrieves the following information.
FieldDescription
NameThe full name of the API call.
URLThe URL of the API call. To view API calls nested under the returned call, run the URL.
AllowedOperations

The operations that can be performed using the API call. Possible values are:

OperationDescription
GETRetrieve data
POSTCreate record
PUTUpdate data
DELETE 

Sample JSON response

Sample XML response

On this page:   

See also:


  • No labels