Skip to content

Developers

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

104 results found

  1. Get Invoice

    I'm trying to retrieve an invoice via the API with the endpoint /accounts/{accountId}/invoices/{invoiceId} but in the documentation it is impossible to make the call work:
    https://app.swaggerhub.com/apis-docs/WildApricot/wild-apricot_public_api/8.03.0#/Finances.Invoices/GetInvoiceDetails

    The first parameter which should correspond to accountId is replaced by () and in the return example there is only "string".
    If I test the endpoint, the accountId parameter is not sent with my value.

    For information, I tested other API endpoints and they work:
    - /
    - /accounts
    - /accounts/{accountId}
    - /accounts/{accountId}/contacts
    - /accounts/{accountId}/contacts/{contactId}

    So I tested a PHP example provided by Wildapricot:
    https://github.com/WildApricot/ApiSamples/blob/master/PHP/sampleApplication.php
    I replaced the connection values and everything works fine.

    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

    Resolved  ·  2 comments  ·  API  ·  Admin →
  2. Support Coupon Code for Membership Application Non-Admin API

    In the Non-Admin API, the "rpc/{accountId}/ApplyForRenewal" call, the API documentation shows that a "Coupon Code" can be submitted as part of the body of the request. The "rpc/{accountId}/applyForMembership" call does not show a "Coupon Code" in the documentation.

    Is it supported? If yes, how should the request be formatted? If it is not supported, is there an alternate way to add a discount code to a membership invoice via API?

    I have tried the following JSON body. It successfully creates a pending membership with the correct Level, but the discount code is ignored. (no error, it is just ignored). 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

    2 comments  ·  API  ·  Admin →
  3. auth0

    I have built a sms portal using Laravel + Auth0/Google_SSO + Wild Apricot (read only) API's, which works great. That Auth0 authenticated users against the Google user repository, but now have started building a second Laravel + Auth0 + Wild Apricot (read & write) API's where I want to first be able to use the Auth0 SSO to authenticate against Wild Apricot. I am using their "oauth capable" social login (URL: https://auth0.com/docs/authenticate/identity-providers/social-identity-providers/oauth2 ), which seems to work. I get the WA username/password login screen and it signs in, but there it stops and seems like the token that is issued…

    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

    Resolved  ·  1 comment  ·  API  ·  Admin →
  4. Authentication for the API call to observe the Contact's privacy settings

    We are using the API https://api.wildapricot.org/v2/accounts/\(id)/contacts to get the list of contacts.

    We use User login + password authentication for the API call.

    If we use an admin account for the API authentication we get all fields for each contact, even fields that the contact has marked as "No access" in privacy. If we use a regular user account for the authentication we get immediately an HTTP 403 unauthorized status to even run the query.

    So the question: how do we set up the authentication for this API call so that the query only returns contact fields that the contact…

    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  ·  Admin →
  5. Date timezone?

    1. 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 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  ·  Admin →
    Resolved  ·  Dmitry Smirnov responded

    API 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:00

    AI uses UTC offset of your organization’s timezone.

  6. 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 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  ·  Admin →
  7. 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-urlencoded

    granttype=clientcredentials&scope=auto

    (My Attempt)--------------------------------------------------------------------

    object WAApiCallService {
    private const val APIKEY = "xxxxxxxxxxxxxxxxxxxx"
    private const val BASE
    URL = "https://oauth.wildapricot.org"
    private val AUTH = "Basic" + Base64.encodeToString(APIKEY.toByteArray(), Base64.NOWRAP)
    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)
    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  ·  Admin →
  8. 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  ·  How to  ·  Admin →
    Resolved  ·  Dmitry Smirnov responded

    Wild Apricot does not provide direct access to the database. Please use API instead.

  9. 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 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  ·  Admin →
  10. 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 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

    5 comments  ·  How to  ·  Admin →
  11. file attachment API

    Now that WA can save file attachments, can we get an API, similar to /photos that can retrieve the attachment by Id?

    9 votes

    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

    3 comments  ·  API  ·  Admin →
  12. 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 11111111

    What am I doing wrong?
    Thanks,
    Jay

    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  ·  Admin →
  13. 3 votes

    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

    8 comments  ·  API  ·  Admin →
  14. 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 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  ·  How to  ·  Admin →
  15. 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

    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

    4 comments  ·  API  ·  Admin →
  16. 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!

    3 votes

    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  ·  Admin →
    Resolved  ·  Team Mobile responded

    Hello!
    The GroupParticipation field is included in the contact details endpoint if a logged user has enough rights to see it.

  17. 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 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  ·  How to  ·  Admin →
    Resolved  ·  Dmitry Smirnov responded

    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.

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

    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  ·  Admin →
  19. 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

    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

    3 comments  ·  API  ·  Admin →
  20. 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

    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

    Resolved  ·  7 comments  ·  API  ·  Admin →
← Previous 1 3 4 5 6
  • Don't see your idea?

Developers

Categories

Feedback and Knowledge Base