Follow

Accounts API call

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.

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 information for all accounts

Syntax
GET [baseAPIaddress]/v2/Accounts

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

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

Retrieving information for a specific account

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]

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
GET https://api.wildapricot.org/v2/Accounts/58293

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

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

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

Id
The account identifier.

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

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.

Url
The address of the API call.

Sample JSON response

[
{
"PrimaryDomainName": "stevelivetestsite.wildapricot.org",
"Resources": [
{
"Name": "Contacts",
"Url": "http://api.wildapricot.org/v2/accounts/42353/Contacts/",
"AllowedOperations": [
"GET",
"POST",
"PUT"
]
},
{
"Name": "Membership levels",
"Url": "http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Contact fields",
"Url": "http://api.wildapricot.org/v2/accounts/42353/ContactFields/",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Membership groups",
"Url": "http://api.wildapricot.org/v2/accounts/42353/MembershipGroups/",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Saved searches",
"Url": "http://api.wildapricot.org/v2/accounts/42353/SavedSearches/",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Bundles",
"Url": "http://api.wildapricot.org/v2/accounts/42353/Bundles/",
"Description": "Requires levelId query string parameter.",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Invoices",
"Url": "http://api.wildapricot.org/v2/accounts/42353/Invoices/",
"Description": "Requires contactId or eventId query string parameter.",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Payments",
"Url": "http://api.wildapricot.org/v2/accounts/42353/Payments/",
"Description": "Requires contactId query string parameter.",
"AllowedOperations": [
"GET",
"POST",
"DELETE"
]
},
{
"Name": "Payment allocations",
"Url": "http://api.wildapricot.org/v2/accounts/42353/PaymentAllocations/",
"Description": "Requires paymentId or invoiceId query string parameter.",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Tenders",
"Url": "http://api.wildapricot.org/v2/accounts/42353/Tenders/",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Events",
"Url": "http://api.wildapricot.org/v2/accounts/42353/Events/",
"AllowedOperations": [
"GET"
]
},
{
"Name": "Event registrations",
"Url": "http://api.wildapricot.org/v2/accounts/42353/EventRegistrations/",
"Description": "Requires contactId or eventId query string parameter.",
"AllowedOperations": [
"GET",
"POST",
"PUT",
"DELETE"
]
}
],
"Id": 42353,
"Url": "http://api.wildapricot.org/v2/Accounts/42353",
"Name": "International Association of Typographers"
}
]

Sample XML response

<ArrayOfAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.wildapricot.org">
<Account>
<Id>42353</Id>
<Url>http://api.wildapricot.org/v2/Accounts/42353</Url>
<Name>International Association of Typographers</Name>
<ContactLimitInfo>
<BillingPlanContactsLimit>500</BillingPlanContactsLimit>
<CurrentContactsCount>28</CurrentContactsCount>
</ContactLimitInfo>
<PrimaryDomainName>stevelivetestsite.wildapricot.org</PrimaryDomainName>
<Resources>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
<d5p1:string>POST</d5p1:string>
<d5p1:string>PUT</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Contacts</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/Contacts/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Membership levels</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Contact fields</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/ContactFields/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Member groups</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/MemberGroups/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Saved searches</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/SavedSearches/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description>Requires levelId query string parameter.</Description>
<Name>Bundles</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/Bundles/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description>Requires contactId or eventId query string parameter.</Description>
<Name>Invoices</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/Invoices/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
<d5p1:string>POST</d5p1:string>
<d5p1:string>DELETE</d5p1:string>
</AllowedOperations>
<Description>Requires contactId query string parameter.</Description>
<Name>Payments</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/Payments/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description>Requires paymentId or invoiceId query string parameter.</Description>
<Name>Payment allocations</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/PaymentAllocations/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Tenders</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/Tenders/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Events</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/Events/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
<d5p1:string>POST</d5p1:string>
<d5p1:string>PUT</d5p1:string>
<d5p1:string>DELETE</d5p1:string>
</AllowedOperations>
<Description>Requires contactId or eventId query string parameter.</Description>
<Name>Event registrations</Name>
<Url>http://api.wildapricot.org/v2/accounts/42353/EventRegistrations/</Url>
</Resource>
</Resources>
</Account>
<Account>
<Id>42360</Id>
<Url>http://api.wildapricot.org/v2/Accounts/42360</Url>
<Name>American Association of Typographers</Name>
<ContactLimitInfo>
<BillingPlanContactsLimit>500</BillingPlanContactsLimit>
<CurrentContactsCount>28</CurrentContactsCount>
</ContactLimitInfo>
<PrimaryDomainName>WaMobileApp.dev8.bonasource.com</PrimaryDomainName>
<Resources>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
<d5p1:string>POST</d5p1:string>
<d5p1:string>PUT</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Contacts</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/Contacts/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Membership levels</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/MembershipLevels/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Contact fields</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/ContactFields/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Member groups</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/MemberGroups/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Saved searches</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/SavedSearches/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description>Requires levelId query string parameter.</Description>
<Name>Bundles</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/Bundles/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description>Requires contactId or eventId query string parameter.</Description>
<Name>Invoices</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/Invoices/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
<d5p1:string>POST</d5p1:string>
<d5p1:string>DELETE</d5p1:string>
</AllowedOperations>
<Description>Requires contactId query string parameter.</Description>
<Name>Payments</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/Payments/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description>Requires paymentId or invoiceId query string parameter.</Description>
<Name>Payment allocations</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/PaymentAllocations/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Tenders</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/Tenders/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
</AllowedOperations>
<Description i:nil="true" />
<Name>Events</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/Events/</Url>
</Resource>
<Resource>
<AllowedOperations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>GET</d5p1:string>
<d5p1:string>POST</d5p1:string>
<d5p1:string>PUT</d5p1:string>
<d5p1:string>DELETE</d5p1:string>
</AllowedOperations>
<Description>Requires contactId or eventId query string parameter.</Description>
<Name>Event registrations</Name>
<Url>http://api.wildapricot.org/v2/accounts/42360/EventRegistrations/</Url>
</Resource>
</Resources>
</Account>
</ArrayOfAccount>

0 Comments

Please sign in to leave a comment.

Search: WildApricot.com 

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