Developers

Mostly about Wild Apricot API. Feel free to share examples of your code!

  1. Contact API Never Returns Contacts

    We are using the API get Contacts API query. Sometimes and intermittently our query returns the Contacts as expected but more often enters a state where it never returns the results. Below are logs of both cases. Our question for the failed case : "what API call do we need to make to retrieve the Contact results?"

    Here is the sequence when the call returns the contacts successfully. We assume that we should call the ResultUrl from the first response to receive the list of contacts and that approach does return the data :-

    Start API CALL, path: https://api.wildapricot.org/v2/accounts/<id>/contacts…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    2 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    There are 2 options:

    1. If you need data immediately, then you may add a parameter $async=false to the initial query. With this flag API returns a list immediately. If your number of contacts is below 500 it is a reasonable option.

    2 Another option is to do exactly what you do, but wait for several seconds between API calls.

    No matter what option you prefer, I’d recommend using $select parameter to read only the fields you actually need. It will significantly improve performance.

    Here is an example:

    GET https://api.wildapricot.com/v2.2/Accounts/183112/Contacts/?$async=false&$select='First name’,‘Last name’,‘Renewal due’

  2. JSON response for eventregistrations?eventId=434xxxx fails a json_decode test with NULL

    I am querying now on the eventregistrations API and have the API query working through https://api.wildapricot.org/ui/home/RequestOAuthToken , but the result set fails a json_decode action with NULL - which I presume means it is not JSON structured. Not sure how to proceed with solving for this. I am running this through the php sample application, which works.. but when adapting to test for this eventregistrations query, the apparent JSON result fails the decode test and hence nothing is available to the foreach loop to extract the right information.

    Running this query, which works fine..

    https://l.facebook.com/l.php?u=https%3A%2F%2Fapi.wildapricot.org%2Fv2.2%2Faccounts%2F1234567890%2Feventregistrations%3FeventId%3D4344015%26fbclid%3DIwAR3fKL6K25MQZIrov9EYsXFhQVEzXKlPOzCDK7HxO0g7uEYdYRTy-6sHnGQ&h=AT1hreSFqkWarrlAM6Wfjd5qPxfJFJ_jTgzZ4vwNilh_OyC8eVdE1dw15Ab_ESS4gRo3ZudF6nWUQdqi6FCcIRDRjZTv4cGCpIh4ULxzTD9DWFJw0NgoyyXtU4ZrZTaToUYhN8o&__tn__=-UK-R&c[0]=AT0qQTLupLZd5d7sgyM9tb3J0rQ4JkLlK6SHLVNIbdCWpH8fFtgvHMjqT1uln6KtExBXEeDdnzEIozaPhA3jwQnEGwqT0code7yc6J38fMHF7nXFBAj1HpILaGi3uTjWCShzKR_V1p_kiZzqPdSdSA1Vjni20A3doSA

    .. gives this response >…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  3. SentEmailRecipients & Opened & ClickedLinks

    Question about the results returned by SentEmailRecipients (https://app.swaggerhub.com/apis-docs/WildApricot/wild-apricot_public_api/7.15.0#/Emailing.SentEmailRecipients/SentEmailRecipientList) - if a user clicks a tracked link in an email received from Wild Apricot, is the Opened flag also set to TRUE (even if the user disallows loading the code or pixel or whatever that's likely used to track email opens - or is this a non-issue [i.e., user cannot disable Wild Apricot tracking opening of email])?

    Thank you.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  4. Use API to update member's contactfield setting

    /publicview/v1/accounts/{accountId}/contactfields only allow get method.

    Is there any way to update the Access field of a contact field?
    Without this api, it is impossible to allow user to edit their field privacy in 3rd party app.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  5. /v2.1/accounts/335649/events/ unable to Sort on StartDate asc

    So I'm doing a GET on this endpoint

    /v2.1/accounts/335649/events/?$filter=IsUpcoming%20eq%20True&$sort=ByStartDate%20asc

    And for the life of me it seems to ignore the ByStartDate asc part.

    Any ideas ?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  6. Date filter on API events query broken

    This URL - https://api.wildapricot.org/publicview/v1/accounts/<accountid>/events?%24filter=StartDate%20gt%202020-01-01 only returns events in the future even though there are 100's of events between 2020-01-01 and now (2020-10-19). According to the doc the filter should return every event after 2020-01-01.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  7. How to format API event query with date filter in Swift?

    I simply copy and paste the query sample from Swagger but get HTTP status code 400 (invalid request). How do I format dates for this query?

    https://api.wildapricot.org/publicview/v1/accounts/99999/events?%24filter=%24filter%3DStartDate%20gt%202016-011-02

    Also, why does the date in the example appear to have 3 digits for the month 011?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  8. Rendering XML Feed from WA to WP website

    Hi, I have successfully been able to use SwaggerHub to authenticate and return values (an events list from our Wild Apricot Db) into the SwaggerHub tool. Now, I am trying to render the results onto a WordPress webpage using an XML rendering plugin. However, that plugin requires a URL that ends in .xml... Unfortunately, I don't see where that is provided by SwaggerHub/Wild Apricot. I just get a URL that ends with /events. So, I am halfway there. Just need the final leg. Thanks!

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  9. [Bounty] How to register guests using the Member Api (v1)?

    It looks like registering guests is available through the Admin API v2. However I need to register guests using the Member API which I believe comes only in v1.

    I am using a javascript application on WA page: https://gethelp.wildapricot.com/en/articles/1705-working-with-api-from-javascript

    Note that for some reason in the example above the v2 (admin?) API is used to query from javascript. However when I try this as a member I get a 403 error. It does work with the member API though.

    Am I missing something? I you think you can help please get in touch. There is a potential bounty available.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  10. Events API StartDate filtering only returning first event, not all events?

    Hi, I have two events on a single date, yet calling the Events API and filtering on that date only returns one of the events?

    The code snippet:

        $("#listSessionButton").click(function(){   
             api.apiRequest({
                apiUrl: api.apiUrls.events({
                    $filter: "StartDate eq 2020-03-01",
                    idsOnly: 1
                    }),
                method: "GET",
                success: function (data, textStatus, jqXhr) {
                    console.table(data)
                    alert(data.EventsIdentifiers);
    

    The results:

    EventsIdentifiers 3743709
    Object
    EventsIdentifiers: Array(1)
    0: 3743709
    length: 1

    The events in the GUI attached.

    Thanks very much
    Kevin

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  11. Receipt email should be sent automatically once payment is created via API

    If there is an option to create a new payment via the API then it would make sense that an automatic receipt email should be sent out as well or at least the option whether to trigger this or not.

    We have created our custom payment integration using the APIs because our local payment gateway provider is not supported. After the payment is completed the API registers the payment in WA towards the specified invoices.

    We were surprised that the member does not get a receipt email and that it has to be manually done which partly defeats the purpose…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  12. Add invoice id or event registration id into event email template

    We cannot integrate with any of the available online payment providers as none of them are supported in our country.

    What I thought to do is use provide the users a link to a third-party code that would use WildApricot APIs to retrieve and update invoice information and that would integrate with our payment providers.

    The link would need to include some information about what the user is trying to pay and the most natural thing would be to include the invoice id or event registration id in the link query parameters so that the third-party code can use the…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  13. Integrate members into searchable directory on wordpress

    I have an active member list of 750 members that I would like to export to a Wordpress. The WA site will remain. The Wordpress site would focus on matching members to customers, and I would need a search feature that could search by zip. Is there aa wild apricot partner that has done this? I’m looking to hire.

    Mike

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  14. Check in member to an event using event registrations API

    Knowing the eventID and memberID, it would be ideal if the API could allow me to check that member into that eventregistation.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  15. Wild Apricot Auth w/Mobile (Specifically React Native)

    So we're working on a mobile app for our members at ITEA. Rather than create yet one more account on yet one more app, this app will hit the Wild Apricot API, acquire an auth token based on a member's email and password, and then send back the user's information via the contacts/me endpoint. One login; two platforms. Makes sense.

    We're running into some hurdles with the auth API for mobile. Specifically, I'm using React Native and a package called react-native-app-auth to handle the OAuth process. This package in turn uses the AppAuth SDK for iOS and Android.

    Hurdles:

    1)…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  16. How to Encode Quotes in PHP for API

    I'm using PHP to create a new event via the API just fine. However if the Name of the event has single or double quotes or an ampersand sign, these get converted to utf8 unicode in the published WA event. I can't figure out what PHP encoding WA needs in the POST/PUT for the Name to get a properly decoded result in the WA admin. I've tried htmlentities(), htmlspecialchars(), and json_encode() to no avail.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  17. GET, PUT, and POST for blog content

    I would like to be able to retrieve, update, and create blog posts via the API.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  18. Deactivate

    I would like to be able to deactivate a member through the API. Deactivating a pending membership is possible through /rpc/{accountId}/RejectPendingMembership, but that doesn't seem to be intended for existing memberships.

    I tried sending a PUT to /rpc/Accounts/{accountId}/Contacts/{member_id} with 'MembershipEnabled: false', as well as setting FieldValues like "Member", "SuspendedMember", and "Membership enabled", but this returned a 400 error.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  19. v2.1 getEventDetails returns 404 for existing events

    I have a list of event IDs that I need to verify still exist in WildApricot. For some of them, the call to /accounts/{accountId}/events/{eventId} returns a 404, even though I can search and find them in the admin UI (Events > Event List). I am not passing any filters to the API call.

    Any ideas why the API returns a 404?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  20. Integration to Reservation System

    Researching member management systems,Have/Can you integrate with Reservation System? We use RezExpertCentral Application. Member have to be active in order to make a reservation. Can your Admin API be used for that validation?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  • Don't see your idea?

Developers

Categories

Feedback and Knowledge Base