Developers

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

  1. Contact API Returns Dataset or Status

    Sometimes the v2.2 API calls (done via API token and auth built on the PHP class from your sampleApplication.php on GitHub) to get a specific Contact returns the user's fieldset, and sometimes it returns an object with a State of either 'Waiting' or 'Complete'.

    I've tried adding ?$async=false but it doesn't seem to change anything. Matter of fact, when I added $async=false&$select='First name','Last name' (as mentioned here in the forums, previously) I got a 400 bad request.

    It seems like sometimes the API kicks butt and returns everything I need instantly, but other times it sends a Status of either…

    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 →
  2. Privacy for Contact List

    I had posted last week that I cant find out how the contacts list API respects privacy settings for each contact but as yet, no replies. Is there an API that can return the privacy settings a contact has specified? In this way, our app could maybe parse those privacy settings and figure out what contact fields (e.g. phone, email) it can display. In the absence of any such API, or the contact list API ignoring contact privacy our app will be making personal private information public which is obviously a show stopper.

    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  ·  Flag idea as inappropriate…  ·  Admin →
  3. All Events API not returning all data

    Hi, I am calling all the events and get all the data up until 'tags', but the swaggerhub documentation shows that details, description, etc. I know all of this can be accessed through the /events/{event_id}, but then if I am querying all the upcoming events and need the details, I am then looping through and performing 20+ api calls, which seems redundant. I was curious if you can retrieve the details, description, etc via the /events/ api, or if the documentation has it listed incorrectly. 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  ·  Flag idea as inappropriate…  ·  Admin →
  4. 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

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

    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’

  5. Extend non-admin API to allow filtering of events

    The non-admin API returns a list of all events that the current user has registered for. While I can filter the results to show only future events, it would be nice if the API did this for me. The admin API allows this by letting me specify the StartDate.

    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 →
  6. 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 →
  7. api create event reminder emails

    I am already using the following WA API to create events programmatically (we create several hundred events per year):

     POST   ​/accounts​/{accountId}​/events
    

    However, I can't figure out how to create these events with the following emails already configured:

    • Registration Confirmation Email
    • Registration Cancellation Email
    • Registration Reminder 1 (scheduled for 1 day before event)

    I've looked through the API information on this webpage (https://app.swaggerhub.com/apis-docs/WildApricot/wild-apricot_public_api/7.15.0#/), but I can't seem to find the appropriate attributes in the data model.

    Does anyone what attributes need to be set for these 3 emails to be configured for my events?

    Thank you in advance for…

    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  ·  Flag idea as inappropriate…  ·  Admin →
  8. Batch request does not support member api ?

    Tried below payload

    [
    {
    "Id": "profile",
    "Order": 0,
    "PathAndQuery": "/v2.2/accounts/{{accountId}}/contacts",
    "Method": "GET"
    },
    ]

    But get this response

    [
    {
    "RequestId": "profile",
    "HttpStatusCode": 400,
    "HttpReasonPhrase": "Request path does not look like valid API request",
    "ResponseData": null
    }
    ]

    2 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

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
  9. 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 →
  10. /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 →
  11. How to map radio button or multiple choice field for add contact via api

    I have the contact form with different text box fields and radion buttons and multiple-choice values. i need to add these form entries in my Wild Apricot Contact list via API.

    I have mapped successfully string and single-line text fields. but not able to map the like radio button fields and checkbox fields. please can you help me out this? i am using node.js to send API requests.

    2 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

    9 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
  12. Custom field that a member can only view from a Wild Apricot restricted webpage using the API from JavaScript

    I would like the ability to create a membership database field that a logged-in member can view from a Wild Apricot restricted webpage using the API from JavaScript. Administrators with Membership manager access would be able to view and edit this field.

    2 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

    21 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →
  13. 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 →
  14. 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 →
  15. 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 →
  16. Wildapricot hosting code to access the API

    The webpage here: https://gethelp.wildapricot.com/en/articles/182 suggests that we can access wildapricot API's from wildapricot hosted web pages. ("Wild Apricot's APIs can be accessed from a 3rd-party server or application, or from a Wild Apricot site page. For information on differences between the two, see API access options.")

    However the API access options page (https://gethelp.wildapricot.com/en/articles/484) only talks about access from a 3rd-party site, and, this request, says we can't run PHP on the wildapricot site: https://forums.wildapricot.com/forums/308926-designers/suggestions/8821459-inserting-php-pages#comments

    So how can we host 'code' on the wildapricot servers that can access the API please?

    We would like to write some custom…

    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  ·  Flag idea as inappropriate…  ·  Admin →
  17. 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?

    5 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  ·  Flag idea as inappropriate…  ·  Admin →
  18. [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 →
  19. How do we get fullSize images from the Picture API?

    I'm having trouble fetching full size images from the Pictures API. If I use the fullSize=true parameter I still get a thumbnail image back.

    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

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

    API returns the best quality it can find. If you upload images through API or a mobile app, then a high quality image is stored as well as a smaller one. But if you upload an image through the web interface, then system does not keep a larger image.

  20. 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 →
← Previous 1 3
  • Don't see your idea?

Developers

Categories

Feedback and Knowledge Base