Developers
Mostly about Wild Apricot API. Feel free to share examples of your code!
-
Date timezone?
- Date timezone - If I get a datetime back from an API call in JSON (e.g. an event start date) in which timezone is that date expressed? I was thinking it would be expressed in UTC but that does not seem to be the case. It appears to be expressed in my current timezone PDT. e.g. if my event in California (PDT) starts at 9:00 am PDT then does the event start time JSON string returned come back as 9:00 am or 4:00 pm? (i.e. expressed in the PDT or UTC time zone)
The JSON date string in question has…
1 voteAPI returns dates in ISO 8601 format. Here is an example:
“2019-11-15T15:05:39.453-04:00”
date: 2019-11-15
time: 15:05:39.453
UTC offcet: -04:00AI uses UTC offset of your organization’s timezone.
-
export membership data
I have been reading the doc but I don't see what API call I use to download a variety of member data. I need more than Membership Level.
I want an API call like the Member List Export, where I can choose the fields.
I want to export (for all members) member first,last,level,status, and one custom field we have in our database. Prefer output as CSV, but JSON would be fine.
I need this via the API because I want to automate it to feed into a Access Validation system we have developed, not google docs or Excel, etc.
I…1 voteYou can receive all contacts data by calling the https://api.wildapricot.org/v2.2/accounts/ACCOUNT_ID/Contacts/ endpoint. As it could be a long query, the call will be executed asynchronically. You will receive the result ID and then you will be able to receive actual results by calling the https://api.wildapricot.org/v2.2/accounts/192743/Contacts/?resultId=RESULT_ID
-
Why am I getting 404 error when requesting token? (kotlin/android/retrofit)
(TEMPLATE)
POST /auth/token HTTP/1.1
Host: oauth.wildapricot.org
Authorization: Basic QVBJS0VZOm85c2U4N3Jnb2l5c29lcjk4MDcwOS0=
Content-type: application/x-www-form-urlencodedgranttype=clientcredentials&scope=auto
(My Attempt)--------------------------------------------------------------------
object WAApiCallService {
private const val API_KEY = "xxxxxxxxxxxxxxxxxxxx"
private const val BASE_URL = "<a rel="nofollow noreferrer" href="https://oauth.wildapricot.org"">https://oauth.wildapricot.org"</a>;
private val AUTH = "Basic" + Base64.encodeToString(API_KEY.toByteArray(), Base64.NO_WRAP)
private const val CONTENT_TYPE = "application/x-www-form-urlencoded"private var api:WAApiCall? = null
private fun getWAApi(context: Context) : WAApiCall {
if(api==null){
val OkHttpClient = OkHttpClient.Builder()
val logging = HttpLoggingInterceptor()
logging.level = HttpLoggingInterceptor.Level.BODY
if(BuildConfig.DEBUG){
OkHttpClient.addInterceptor(logging)
}
//define and add a cache
val cacheSize = 5 * 1024 * 1024L // = 5mb cache
val cache = Cache(context.cacheDir, cacheSize)
//add cache to…1 voteAPI endpoint should be https://oauth.wildapricot.org/auth/token
but you post to https://oauth.wildapricot.org/auth/token%20HTTP/1.1 -
1 vote
Wild Apricot does not provide direct access to the database. Please use API instead.
-
Change Event AccessLevel from API
Please provide a way to change Event AccessLevel from API. I clone/create events via programs using API and need to change AccessLevel to Public as final step to enable registration. Thanks!
1 voteHello Steve,
You can change AccessLevel via API.
As it is written in our documentation (https://app.swaggerhub.com/apis/WildApricot/wild-apricot_public_api/2.1.0#/Events/UpdateEvent), this request body will change AccessLevel to Public:{
“Id”: yourEventID,
“Details”: {
“AccessControl”: {
“AccessLevel”: “Public”
}
}
}I hope it helps!
-
Update User's group participation api V2.2
I'm trying to update a user's group participation via the put endpoint /accounts/{accountId}/contacts/{contactId}. I'm getting a 200 returned, but the returned model doesn't reflect the attempted updates. Any advice is appreciated. The following is the relevant section of json for the update.
"FieldValues": [{
"FieldName": "Group participation",
"Value": [
{
"Id": 559646,
"Label": "tmpCardGroup"}],
"SystemCode": "Groups"
}]1 voteFeel free to comment if your issue remains unresolved
-
Get member first name, last name, email address from id
I have tried unsuccessfully to get a user first name, last name, email address from the ID.
Here is what I tried to get the last name:
https://api.wildapricot.org/v2.1/accounts/12345/contacts?async=false&$filter=$async=false&?$select='Last%20Name'%$filter='Member ID' eq 11111111What am I doing wrong?
Thanks,
Jay1 voteThere is a strange mix of parameters and invalid syntax in this example. Please check documentation to find right syntax.
To get a single contact details by id
https://api.wildapricot.org/v2.1/accounts/{ACCOUNT_ID}/contacts/{CONTACT_ID}As an alternative to writing code you can use out module on Integromat https://www.integromat.com/en/integrations/wild-apricot
-
3 votes
Take a look at a sample web app https://github.com/WildApricot/ApiSamples/tree/master/C%23/OAuthClientTestApp
-
API Documentation
Can someone point me to documentation describing how to get started developing on top of Wild Apricot, including what language to use to interact with the API? I'm a developer but haven't developed on top of a content management system before. I need to be able to display information from the Member table for a specific event.
1 voteAPI specification: https://app.swaggerhub.com/search?query=%20WildApricot
Help pages: https://gethelp.wildapricot.com/en/categories/32-wild-apricot-apis
Code samples: https://github.com/WildApricot/ApiSamples
Instead of writing code you could use Integromat service to implement you custom automation. Here is a link for quick start: https://gethelp.wildapricot.com/en/articles/1653
-
Cancel Registration API
We need to be able to cancel registrations via the API. The only option currently is to delete the registration, which is far from ideal since there is no longer any record of the registration in WA, and no way to restore the registration manually.
4 votes -
Add Group participation to the publicview API ContactsMe model
I would find it really helpful to include "Group participation" in the ContactMe model of the publicview api (https://app.swaggerhub.com/apis-docs/WildApricot/wild-apricotapifornonadministrative_access/1.0.0#).
For consistency, it could be located in the FieldValues collection. Given that /Sys/Profile shows the group participation to users, this addition seems like it would not introduce any new information for the client.
My use case is that my 3rd party OAuth app would like to restrict access to content based on the WA group participation in a way that is consistent with the WA site page restrictions.
Thanks!
3 votesHello!
The GroupParticipation field is included in the contact details endpoint if a logged user has enough rights to see it. -
getting an oath token using curl
I am attempting to write a tiny app to download my club's calendar from wild apricot. I plan to write this in python 3, triggered by cron. The first step is to get an oauth token. As a test I tried the following curl command but I receive a 401/unauthorized error. Please note that XXXXX is not my real application ID :-)
I tried variations, and also some similar code in python with the same result.
Any hints?
curl -v -H 'Authorization: Basic BASE64ENCODED("XXXXX")' -H 'Content-Type: application/json' -H 'Transfer-Encoding: chunked' -d '{"granttype":"client_credentials", "scope":"auto"}' https://oauth.wildapricot.org/auth/token
1 voteHere is an example
1 Build your Authorization header.
– Assume you API key is b8gxv-njhci-XXXXXXXXXXXX-50
– encode the line “APIKEY:b8gxv-njhci-XXXXXXXXXXXX-50”, you will get
“QVBJS0VZOmI4Z3h2LW5qaGNpLVhYWFhYWFhYWFhYWC01MA==”2 use this value to make a call
curl -X POST \
https://oauth.wildapricot.org/auth/token \
-H ‘Authorization: Basic QVBJS0VZOmI4Z3h2LW5qaGNpLVhYWFhYWFhYWFhYWC01MA==’ \
-H ‘Content-Type: application/x-www-form-urlencoded’ \
-d ‘scope=auto&grant_type=client_credentials’==
I recommend to use POSTMAN before writing any code. -
GET /accounts/{accountId}/events
The swagger docs do not really show how to add the parameters to the HTTP Get request (e.g., $filter). For example, how do I format the request to get all events that have the substring "XYZ" in a Tags field?
Also what is the syntax of the "TextIndex, Supported operations: substringof." parameter? You have all these good parameters in the Swagger site, but no real examples of how to use the syntax. Are we supposed to guess? Help me out here please. Thanks.1 voteAs described in swagger, $filter parameter should be passed as a query string parameter.
It is not possible to look for substrings in tags.
Here is a good examples of using different kinds of comparison operators: https://gethelp.wildapricot.com/en/articles/499 find ‘Relational operators’ section.
-
API and custom fields - how to reference them in $select or $filter
Hi. According to some of the documentation it implies that I can use a custom fields' name to reference it. I can directly reference common fields as a $select parameter, but can only reference other fields using their custom-xxx tag, like this:
'$select' => 'First name, Last name, Email, custom-8097667,
custom-8097668, custom-8161502, custom-8097675, custom-8017535'The custom field tag does not seem to appear anywhere in Membership fields area of the WA database though so the only way I can find it out is by trawling through json data manually.
Is there a better way to reference those fields, or to…
1 votesee comments
-
Is it correct that users cannot get their membership data via API?
I'm working with a tool called Cognito Forms that allow some fairly complex form functionality. One great feature is the ability to pass values to a form embedded on a Wild Apricot page.
We are currently working on a feature where a member navigates to a member-only page for expense reimbursement. The page loads an embedded form and pre-fills most of the information.
Right now, I am using the API to use the contacts/me call to load name and email, but I need the contact/{contact-ID} to get the address and phone.
After getting the script completed and pre-populating the form…
1 voteHi Andy,
contacts/me endpoint returns short version of contact data. If you need all field values, just add query string parameter includeDetails=true.
Here is an example:
https://api.wildapricot.org/publicview/v1/accounts/183112/contacts/me?includeDetails=true
-
Swaggerhub returns 403 Forbidden on all requests to API
Real simple: Using Swaggerhub to play with the API. I give it a valid API key, it is able to login/authenticate successfully, but the only function returning code 200 OK is default (/) ... when I try the /accounts function or any other function I get 403. Tried 2 different API keys..... with both read-only and admin level access but No matter what I do I get a 403 trying to test the API using the swaggerhub UI
1 voteThat typically occures if you don’t check “Auto” checkbox in the scopes list (swaggerhub does not allow to check it by default).
So when oAuth service gets your response it creates oAuth token with almost no permissions. Technically it is totally valid situation, but such token is almost useless.
So the solution is to check “Auto” checkbox in the list of scopes.
-
Connecting to PowerApps with Swagger
I've downloaded the Swagger file for administrative access and imported into PowerApps in an attempt to create a custom connector. It asks for several fields (see screen shot in attached file).
I'm not clear on two of the fields to fill in.
For Authorization URL, it is showing a default of:
https://YOUR_ORGANIZATION.wildapricot.com/sys/login/OAuthLogin
I'm not sure what I should replace YOUR_ORGANIZATION with.
It is also requesting a Refresh URL and I don't know what to put in there.
Any help would be appreciated. A documented PowerApps connector would be of general use to the WA community and I'd be happy to…
2 votes -
Access registrants who are on the waitlist via API
We need to be able to export the list of registrants who are on the waitlist. If a course (event) is full, we want to be able to pre-register waitlisted people the next time that we offer the course.
Currently we have to copy-and-paste from the full event to the next event, a tedious and error-prone activity.4 votesWe added a parameter includeWaitList, which allows to get waitlisted registrants through API. Each event registration now has a flag “OnWaitlist” to indicate waitlisted registrations.
See detailed description here https://app.swaggerhub.com/apis/WildApricot/wild-apricot_public_api/2.1.0#/Events.EventRegistrations/GetEventRegistrationsList
-
Need to redirect OLD WA page address to NEW WA page address
I used to make an index.html file with a meta redirect tag but this doesn't happen with WA according to Tech Support.
We originally had a WA site that was modified and the new site has the same pages with different URLs. Our fear is that, for instance, someone may have bookmarked the OLD site's page, and when clicked on brings them to the wrong page.
Help?
1 voteThis could be done with a piece of JS code on obsolete pages. Here is an article about using custom JS on pages: https://gethelp.wildapricot.com/en/articles/212
-
OAUTH - Not getting back authorization token
Perhaps someone in this forum can help answer this question. There aren't any OAuth exampels for PHP.
My code is failing on the last ajax call to the OAuth API. I am getting a NULL response from Wild Apricot.
Perhap someone can let me know what is wrong withthis code:
$credentials = '[client_id]:[secret]';
//extract data from the post
//set POST variables
$url = '<a rel="nofollow noreferrer" href="http://oauth.wildapricot.org/auth/token'">http://oauth.wildapricot.org/auth/token'</a>;
$fields = array(
'grant_type' => "authorization_code",
'code' => CCGetParam("code",0),
'client_id' => '[client_id]',
'redirect_uri' => "<a rel="nofollow noreferrer" href="https://[domain.com]/login2.php"">https://[domain.com]/login2.php"</a>,
'scope' => 'contacts_me'
);//url-ify the data for the POST
foreach($fields as $key=>$value) { $fields_string…1 vote
- Don't see your idea?