Follow

Base API call

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.

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.

Retrieving a list of API versions

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

Syntax
GET https://api.wildapricot.org
Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see API access options.

Response fields

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

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

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.

Version
The version number of the API.

Sample JSON response

[
{
"Version": 2,
"Name": "Wild Apricot API version 2",
"Url": "http://api.wildapricot.org/v2",
"Deprecated": false
}
]

Sample XML response

<ArrayOfApiVersion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.wildapricot.org">
<ApiVersion>
<Deprecated>false</Deprecated>
<Name>Wild Apricot API Version 2</Name>
<Url>http://api.wildapricot.org/v2</Url>
<Version>2</Version>
</ApiVersion>
</ArrayOfApiVersion>

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.

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 call.
Syntax
GET https://api.wildapricot.org/{version}

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

Example
GET https://api.wildapricot.org/v2

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

Response fields

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

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.

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

  • GET
    Retrieve data
  • POST
    Create record
  • PUT
    Update data
  • DELETE
    Delete record

Sample JSON response

{
"Name": "Accounts",
"Url": "https://api.wildapricot.org/v2/Accounts"
}

Sample XML response

<ArrayOfResource xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.wildapricot.org">
<Resource>
<AllowedOperations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>GET</d3p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Accounts</Name>
<Url>http://api.wildapricot.org/v2/Accounts</Url>
</Resource>
</ArrayOfResource>

0 Comments

Please sign in to leave a comment.

Search: WildApricot.com 

About results ( seconds) Sort by: 
Sorry, an error occured when performing search.