Developers

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

How can we make it easier for you to develop on top of Wild Apricot?

(thinking…)

Enter your idea and we'll search to see if someone has already suggested it.

If a similar idea already exists, you can support and comment on it.

If it doesn't exist, you can post your idea so others can support it.

Enter your idea and we'll search to see if someone has already suggested it.

  1. Additional, Administrator-defined, Optionally-searchable Content Types

    Think it would be quite useful to have the ability to (optionally) define additional "Content Types", i.e., types other than the default set already provided (Page contents, Blogs, Forums, Events, & Public Member profiles).

    This capability would add an important, new dimension to the site wide Search Gadget, and would provide a user-configurable means to manage the scope of a user's search capability, by role!

    Such that:

    1. Any number of additional (optionally-defined) content types can be established by a site administrator

    2. These optionally-defined content types can be administrator-selected for inclusion/exclusion: (a) By role and (b) In the site…

    5 votes
    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      Signed in as (Sign out)

      We’ll send you updates on this idea

      0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
    • 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.

      2 votes
      Sign in
      Check!
      (thinking…)
      Reset
      or sign in with
      • facebook
      • google
        Password icon
        Signed in as (Sign out)

        We’ll send you updates on this idea

        3 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
      • Sending email via API

        I'm trying to use the send email API call - https://app.swaggerhub.com/apis-docs/WildApricot/wild-apricot_public_api/2.1.0#/Emailing.Operations/SendEmail but not having any luck.

        I've tried from the API browser and via a Google Apps script. In both, I just get a 400 error.

        I'm POSTing to https://api.wildapricot.org/v2.1/rpc/<ACCOUNT>/email/sendemail, with this as my body:
        {
        "Subject": "test email",
        "Body": "test email",
        "Recipients": [
        {
        "Id": 0,
        "Type": "IndividualRecipient",
        "Name": "test",
        "Email": "<HIDDEN>"
        }
        ],
        "EventId": <EVENTID>
        }

        (account, email and event id have been hidden). Each time, I get a 400 error: Parameter is required: EmailDraftParam.
        The swagger documentation doesn't mention a "EmailDraftParam". What am I doing wrong?

        1 vote
        Sign in
        Check!
        (thinking…)
        Reset
        or sign in with
        • facebook
        • google
          Password icon
          Signed in as (Sign out)

          We’ll send you updates on this idea

          4 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
        • How to drive the saggerhub api

          Hi. It appears that I should be able to use swaggerhub to pull data from my WA database with the API, but I can't figure out how to do this because the code in the code window of swagger is 'read only'. I can see that I have to change it so that it points to my WA site, and although I have an option to enter API key to authenticate, there seems no way to change the site. Help appreciated

          1 vote
          Sign in
          Check!
          (thinking…)
          Reset
          or sign in with
          • facebook
          • google
            Password icon
            Signed in as (Sign out)

            We’ll send you updates on this idea

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

            I have to admit, authorization with login/password through swaggerhub stopped working. Authorization with API key (2-nd in a list) still works.

            I can recommend to use one of these options:
            1 POSTMAN – is a great tool to work with API. It is possible to import swagger description.

            2 Use our test tool at API browser. It is a web application located at https://api.wildapricot.org/ui/home/requestoauthtoken

          • 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
            Sign in
            Check!
            (thinking…)
            Reset
            or sign in with
            • facebook
            • google
              Password icon
              Signed in as (Sign out)

              We’ll send you updates on this idea

              1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
            • 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-apricot_api_for_non_administrative_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!

              1 vote
              Sign in
              Check!
              (thinking…)
              Reset
              or sign in with
              • facebook
              • google
                Password icon
                Signed in as (Sign out)

                We’ll send you updates on this idea

                0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
              • Stripe Connect

                Hi there,
                We understand that Wild Apricot by default allows adding only 1 Stripe/Paypal account in payment settings.
                However we are trying to customize. We want to use Stripe Connect i.e. our Stripe account will have 5 bank accounts added inside it.
                When a user selects 1 of the 5 "Donation Types" from dropdown in donation form, we want to direct the funds to that donation types bank account inside our Stripe account.

                We have a custom php code to achieve this. However how can we use that php code or any other customization you recommend to achieve this functionality…

                1 vote
                Sign in
                Check!
                (thinking…)
                Reset
                or sign in with
                • facebook
                • google
                  Password icon
                  Signed in as (Sign out)

                  We’ll send you updates on this idea

                  0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                • API endpoint for allowing users to cancel registrations

                  The new feature added today to allow users to cancel their own registrations is a good start, but we need to be able to set it through the API for it to really be useful. Is there a plan to add this in the near future?

                  5 votes
                  Sign in
                  Check!
                  (thinking…)
                  Reset
                  or sign in with
                  • facebook
                  • google
                    Password icon
                    Signed in as (Sign out)

                    We’ll send you updates on this idea

                    4 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                  • Provide a working example using XML and Access 2016

                    I am converting an existing (working) application based on the excel example provided by Wild Apricot to work with Access instead of Excel. All I need from the API is to download a list of members. I've found that the Excel code does not work with Access. I've found many workarounds on various VBA boards, but I'm stymied at the final step of actually downloading the XML for the membership roster.

                    These three lines of code from the LoadContacts sub are the problem. The dim statement does not compile in Access. The error is that the 'user defined type is…

                    1 vote
                    Sign in
                    Check!
                    (thinking…)
                    Reset
                    or sign in with
                    • facebook
                    • google
                      Password icon
                      Signed in as (Sign out)

                      We’ll send you updates on this idea

                      0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                    • Orders-products vs Payments?

                      Hi Everyone,

                      I would like to integrate shop orders and payments with an external platform, this means whenever a user buys a digital product through the store, the content is unlocked in the external platform.

                      I'm digging around the API and found a complete API for payments and invoices but, unfortunately, payments and invoices don't have any relationship with orders and products.

                      Are this unimplemented methods of the API?

                      Thanks in advance for any response

                      2 votes
                      Sign in
                      Check!
                      (thinking…)
                      Reset
                      or sign in with
                      • facebook
                      • google
                        Password icon
                        Signed in as (Sign out)

                        We’ll send you updates on this idea

                        0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                      • Single Sign On Very simple Ruby on Rails snippet

                        Hello,
                        I have been able to implement bare bones Wild Apricot single sign on steps in a blank Ruby on Rails project, thanks to Wild Apricot support! Please find attached a redacted and commented version of the code here for anyone who is trying to do similar with their own custom web app. This snippet prints out the ID of the user who is signed in.
                        Cheers!

                        2 votes
                        Sign in
                        Check!
                        (thinking…)
                        Reset
                        or sign in with
                        • facebook
                        • google
                          Password icon
                          Signed in as (Sign out)

                          We’ll send you updates on this idea

                          1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                        • Event registration types created via API cannot be edited in the web interface

                          It is no longer possible to edit an event registration type in the web UI if it was created via an API call. Attempting to load these registration types causes Uncaught Error: Invalid cancellationBehavior to be thrown in the console and the page spins forever without loading.

                          Unfortunately due to the asinine piecemeal implementation of the API it is only possible to set this field through the web interface. See the issue? Yet another reason why you should use your own dang API; you could catch these issues before they break your customers' workflow and piss them off.

                          Console log…

                          1 vote
                          Sign in
                          Check!
                          (thinking…)
                          Reset
                          or sign in with
                          • facebook
                          • google
                            Password icon
                            Signed in as (Sign out)

                            We’ll send you updates on this idea

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

                            An ability to setup cancellation options will be added to the API in the next release – approximately at the end of the month. It’ll fix this issue also.

                            Currently, we fixed all broken registration types (the cancellation option was set to “not allow”) but unfortunately new ones will be created with the same problem for now.

                          • Monthly list of new users

                            I am attempting to create a google doc for our Printing/Mail vendor to easy grab info on the members that renwed or signed up in the last 30 days. The idea is the vendor would just open this share google doc once a month, run the report, export the data.

                            I am using your example from: https://github.com/WildApricot/ApiSamples/tree/master/GoogleScript

                            function getCardData(){
                            Logger.clear();

                            var ui = SpreadsheetApp.getUi();
                            var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
                            var urls = urlBuilder();

                            var token = getToken(ui, urls.getAuthServiceUrl());
                            var accountId = getDataFromApi(urls.getAccountsListUrl(), token)[0].Id;
                            var filter = '\'Renewal date last changed\' ge 2017-10-01 AND \'Mebership Status\' eq Active'
                            var query = getDataFromApi(urls.getCardDataUrl(accountId,…

                            4 votes
                            Sign in
                            Check!
                            (thinking…)
                            Reset
                            or sign in with
                            • facebook
                            • google
                              Password icon
                              Signed in as (Sign out)

                              We’ll send you updates on this idea

                              0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                            • Single sign on for Moodle

                              Has anyone successfully setup single sign in authentication between WA and a Moodle installation? Looking for some guidance/assistance. Thanks in advance -

                              1 vote
                              Sign in
                              Check!
                              (thinking…)
                              Reset
                              or sign in with
                              • facebook
                              • google
                                Password icon
                                Signed in as (Sign out)

                                We’ll send you updates on this idea

                                1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                              • How can I sync WA API and Azure Active Directory?

                                We are looking at using WA with Office 365 to collaborate with our members. Office 365 uses the Azure AD environment which accepts most setups. My question is how we could export WA member data to Azure AD as 'B2B external partners' or, better yet, native AD accounts.

                                1 vote
                                Sign in
                                Check!
                                (thinking…)
                                Reset
                                or sign in with
                                • facebook
                                • google
                                  Password icon
                                  Signed in as (Sign out)

                                  We’ll send you updates on this idea

                                  1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                                • Event creation via API cannot set all fields

                                  I am creating Events using the API and cannot see how the following fields can be set (I can set these as an Administrator in the website) .....
                                  Show registrants who want to be listed
                                  to everyone
                                  to members only
                                  Include pending registrations

                                  Also I cannot see how the schedule for email announcements and reminders for an Event can be set via the API?

                                  2 votes
                                  Sign in
                                  Check!
                                  (thinking…)
                                  Reset
                                  or sign in with
                                  • facebook
                                  • google
                                    Password icon
                                    Signed in as (Sign out)

                                    We’ll send you updates on this idea

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

                                    Status update in case someone new will see this topic:
                                    The section “Show registrants who want to be listed” have been added to API already.

                                    Schedule for email announcements and reminders can’t be set via API at the moment.

                                    As a workaround, you could create a template event on the web, set the start date in the distant future and all settings you need. Then you can clone it via POST request:
                                    api.wildapricot.org/v2/rpc{AccountId}/CloneEvent
                                    The request body should be like this:
                                    {“EventId”: 123456}

                                  • How can I get new member signup information?

                                    I need to get new member details into Drip.co. How do I go about doing that?

                                    1 vote
                                    Sign in
                                    Check!
                                    (thinking…)
                                    Reset
                                    or sign in with
                                    • facebook
                                    • google
                                      Password icon
                                      Signed in as (Sign out)

                                      We’ll send you updates on this idea

                                      3 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                                    • Nicasio Design APP

                                      We are getting very close to launching a comprehensive member facing APP which will allow members to:
                                      1- download the APP
                                      2- Login or Register to your org
                                      3- View and Register to events
                                      4- Edit their profiles
                                      5- Browse member directory

                                      Stand by for updates!

                                      2 votes
                                      Sign in
                                      Check!
                                      (thinking…)
                                      Reset
                                      or sign in with
                                      • facebook
                                      • google
                                        Password icon
                                        Signed in as (Sign out)

                                        We’ll send you updates on this idea

                                        1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                                      • Filtering Account Administrators

                                        How can I return a list of just account administrators?

                                        Using the API Browser, I tried both

                                        $filter=IsAccountAdministrator eq true

                                        and

                                        $filter="Administrator role.Id" eq 256

                                        both return this cryptic error:

                                        ErrorDetails: "One or more errors occurred."

                                        0 votes
                                        Sign in
                                        Check!
                                        (thinking…)
                                        Reset
                                        or sign in with
                                        • facebook
                                        • google
                                          Password icon
                                          Signed in as (Sign out)

                                          We’ll send you updates on this idea

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

                                          Filtering of account admihnistrators is not supported yet. If you are not sure that filtering for some field is supported, then you can look at contact field description. ‘Administrator role’ field has flag “SupportSearch”: false. That’s why filtering fails.

                                          We will implement such filtering in one of future updates.

                                        • “AccessLevel” filter for events

                                          Creating a separate request based on a comment in another one: "Please also add the “AccessLevel” filter for events"

                                          0 votes
                                          Sign in
                                          Check!
                                          (thinking…)
                                          Reset
                                          or sign in with
                                          • facebook
                                          • google
                                            Password icon
                                            Signed in as (Sign out)

                                            We’ll send you updates on this idea

                                            0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                                          ← Previous 1
                                          • Don't see your idea?

                                          Developers

                                          Feedback and Knowledge Base