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. 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 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 →
    • 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 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 →
      • 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 BASE64_ENCODED("XXXXX")' -H 'Content-Type: application/json' -H 'Transfer-Encoding: chunked' -d '{"grant_type":"client_credentials", "scope":"auto"}' https://oauth.wildapricot.org/auth/token

        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  ·  How to  ·  Flag idea as inappropriate…  ·  Admin →

          Here 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.

        • Access to image fields through the API

          Please add access to the image fields through the API - I would like to be able to get the URL of the image the member uploaded.

          10 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

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

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

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

                    That 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.

                  • 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 = 'http://oauth.wildapricot.org/auth/token';
                    $fields = array(
                    'grant_type' => "authorization_code",
                    'code' => CCGetParam("code",0),
                    'client_id' => '[client_id]',
                    'redirect_uri' => "https://[domain.com]/login2.php",
                    'scope' => 'contacts_me'
                    );

                    //url-ify the data for the POST
                    foreach($fields as $key=>$value) { $fields_string .= $key.'='.$value.'&';…

                    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

                      Resolved  ·  1 comment  ·  Flag idea as inappropriate…  ·  Admin →
                    • 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 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  ·  How to  ·  Flag idea as inappropriate…  ·  Admin →
                      • Using API on MS Access 2016

                        I extended the excel sample API V2 app to develop an attendance system for our club. For a number of reasons, we're working to move off of Excel and onto Access. The sample code from WA runs smoothly on Excel, but not on Access. The sample includes the following (in function GetOAuthToken)

                        Dim httpClient as IXMLHTTPRequest
                        Set httpClient = CreateObject("Msxml12.XMLHTTP.3.0")
                        httpClient.Open "POST", url, False

                        (where url = "https://oauth.wildapricot.org/auth/token")

                        The client.open returns 'unauthorized'. I cannot find any documentation on the open method of the httpclient object. And I have no idea what extra authorization I need when working in…

                        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

                          Resolved  ·  3 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                        • Javascript not executing

                          I'm trying to use javascript to hide/empty a span.class on my registration page. When I first type the code in the span empties just as I would assume it would. However once I save the page the javascript no longer executes.

                          <script>
                          $('span.levelRecurring:contains("No recurring payments")').empty();
                          </script>

                          Any ideas?

                          3 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

                            Resolved  ·  2 comments  ·  Flag idea as inappropriate…  ·  Admin →
                          • I have successfully integrated the WA API into Integromat

                            Integromat.com is like Zapier or IFTT but a bit more powerful AND easy to use. I'm added an authorization Connector and two modules for retrieving and filtering Contacts. Using their Slack integration I can now ask for Integromat to calculate a Membership Report and report back to Slack. Next up is a "new member" notification.

                            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

                              3 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                            • "The remote server returned an error: (403) forbidden."

                              I am using the sample visual studio c# program you have provided (see attachment). The program is failing in trying to access https://api.wildapricot.org/v2. Version2 is failing with a 403 forbidden error message. Any suggestions how I could solve this issue?

                              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 →
                              • Swagger

                                Has anyone built an OpenAPI (Swagger) file for connecting to WA APIs? I'm trying to make a sign-in kiosk with Microsoft PowerApps and it connects through a JSON OpenAPI definition.

                                3 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 →
                                • Postman collection

                                  I previously posted about whether anyone had written a Swagger file for WA API that could be used to connct Microsoft PowerApps to WA. New release of PowerApps supports using a Postman collection instead of a Swagger file. Has anyone built a Postman collection for WA 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

                                    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                                  • API calls to update contacts suddenly failing

                                    We have a Google Apps script that is used to update a custom contact field. This code has been working and unchanged for the past year, and has suddenly lost the ability to update contacts. Other API calls to get contacts, update event registrations, etc. are still working fine, but can't update any contact fields through the API. Attempts to do so result in an HTTP 500 error. We are still able to update contacts through the web interface.

                                    Relevant information pasted after the break.

                                    ---------------------------------------------------------------------

                                    Error:
                                    [17-09-16 07:31:21:841 CDT] Exception: Request failed for https://api.wildapricot.org/v2/accounts/84576/Contacts/40772038 returned code 500. Truncated server…

                                    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

                                      2 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                                    • API Upload Pictures

                                      Hey WA Developers, I'm trying to work through some of the API documentation and I'm hung up on the "Uploading Pictures" documentation.
                                      https://help.wildapricot.com/display/DOC/Pictures+API+V2+call
                                      I've got a Google Script constructed to upload an image from Google Drive to my trial WA site and I can't get it to work! 400 response code. Anybody up for taking a look and pointing out what I am doing wrong? Thanks so much!

                                      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

                                        Resolved  ·  1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                                      • Contacts/me Returns null

                                        Hi!
                                        Using some of the sample code from the GitHub repo I've created a few custom PHP pages for events on a third party site. I'm trying to make the registration functionality work.
                                        The problem that I'm running into is the Contacts/me API call returns null even with a user logged in. I'm using the format:
                                        {baseAPIaddress}/{version}/Accounts/{accountID}/Contacts/me

                                        I am able to run Contact/{ContactID} and get the relevant data back. Do anyone know what might cause this?

                                        Thanks, Jason.

                                        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 →
                                        • api events

                                          I am having trouble adding a new event through the api. I get a 403 error. Here is my google script code if anybody would be so kind as to point out where I have messed up. :) Thanks so much.

                                          https://gist.github.com/portercar/945c29474fece0e208991ac27f724203

                                          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

                                            Resolved  ·  1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
                                          ← Previous 1 3 4 5
                                          • Don't see your idea?

                                          Developers

                                          Feedback and Knowledge Base