Home

Download this help site
(PDF 82MB)

Download

Accounts 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 Accounts API call to retrieve details about your Wild Apricot account(s). You can retrieve information for all your accounts or just a specific account.

Retrieving information for all accounts

Syntax

where {baseAPIaddress} is the base API address. For more information, see API access options.

 Example

Retrieving information for a specific account

Syntax

where {baseAPIaddress} is the base API address (see API access options) and {accountID} is the unique account identifier returned by the Accounts API call.

Example

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 of your Wild Apricot accounts, the Accounts API call retrieves the following information.

Field

Description

Id

The account identifier. The account ID also appears on the Account and billing screen in Wild Apricot.

Name

The account name. This corresponds to the organization name as it appears on the Organization details screen.

Url

The address of the API call.

PrimaryDomainName

The primary domain name of the account.

Resources

Available API calls for this account. For each available call, the name, the URL, and the allowed operations of the call are returned.

ContactLimitInfo

Provides details about limits on the number of contacts. The following fields are displayed.

FieldDescription
CurrentContactsCount The current number of contacts in the database.
BillingPlanContactsLimit The maximum number of contacts allowed within the account's billing plan.

Sample JSON response

 Click here to expand/collapse

Sample XML response

 Click here to expand/collapse

On this page:   

See also:

  • No labels