Developers

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

  1. API Report to include event cancellations

    The website provides a method to export all registrants. This report includes cancelled registrants, and those registrants are marked as such.

    I have a need to provide a list of all event registrants (including cancellations) to the various event organizers on a regular basis. I am currently using the "Events.EventRegistrations" API. However, it does not include the cancelled registrants. Is there a way I can include the cancelled registrants via an API? The "Export Registrants" report on the website will do this, but I need to automate this process.

    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)
  2. Date Format in API Create Event POST

    When creating new events (these are simple RSVP events) via the API interface, the web interface shows the new event in the default timezone of the Wild Apricot account. This means my start date is almost always wrong for these events.

    If I am creating a. new event for Utah, for example, I have set the timezone fields of the API payload as follows ;

    "Details": {
    "DescriptionHtml": "A fun family event",
    "PaymentInstructions": "None",
    "TimeZone": {
    "ZoneId": "USA & Canada",
    "Name": "Mountain Time",
    "UtcOffset": -6
    },

    <truncated>

    . When I run my POST command I get back an event_id as…

    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

    4 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. Events filter Isupcoming doesn't work

    Using the following base:
    https://api.wildapricot.org/v2.1/Accounts/Events?

    I can successfully list ALL events, or filter the list by Name using substringof, but...

    The following filters don't work:
    '$filter' => 'EndDate lt 2022-12-31'
    '$filter' => 'IsUpcoming eq true'
    '$filter' => 'IsUpcoming eq True'

    What gives?

    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. Saved search api Get Contact vs Member saved searches, and add creation date

    When getting the saved saved search api results, add a divider between contact vs member saved searches. Have a way to call contact vs member saved searches based on where they were created. Also, save the creation date of the saved search and who created the saved search. This information is shown on Wild Apricot within the Saved search section but is not accessible in the api results.

    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. Why was includeDetails removed from /contacts/me

    I am trying to use the API via JS on a WA page. I need a to fetch a specific field from the logged in member. The docs point to an api version 1 swagger that says that FieldValues can be obtained by appending ?includeDetails=true to the URL - however, this does not work for version 2, and version 1 is not accessible using /sys/api/v1/accounts/

    I also cannot access https://api.wildapricot.org/publicview/v1/accounts through JS due to CORS. How can I get FieldValues via JS on a WA page?

    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. current token does not provide access to scope 'contacts_me'

    I'm trying to simply create software that pulls our contact list. I'm using the API key I've created, I granted full-access. Whenever I try, in Postman, to pull account or contacts, I get "current token does not provide access to scope 'contacts_me'. HTTP 403. I thought the whole point of using the API key is that I get full access, what am I missing?

    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 →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  7. WordPress Login idiosyncrasy

    I am getting odd results when I use the WA Login Plugin - If the user has never logged in before everything works good - a new user account is created and the information is populated perfectly -

    The problem is I created the wordpress site as an admin with my user id and password - the password and email address are the same on both sites but i get "An unknown error has occurred. Please try again later."

    Is the match on the email address, the user name? what do i need to do to correct this ( 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

    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. How to add a Registrant to a Waitlist using the API?

    I have a C# application that successfully adds registrants to an existing event. However, I have been unable to add registrants to the Waitlist when the event has reached its limit.

    The following documentation on the web shows how to add registrations to an event:

    https://app.swaggerhub.com/apis-docs/WildApricot/wild-apricot_public_api/7.6.0#/Events.EventRegistrations/CreateEventRegistration

    However, I have been unable to locate similar documentation for adding to the Waitlist. Does anyone know how to add new registrants to an Event's Waitlist?

    Appreciate any assistance.

    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 →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  9. API endpoint to edit or add access groups to a selected member

    Is there an available API endpoint to edit or add access groups to a selected member? From what I've understood in the documentation the API endpoint available is to retrieve the access groups or the access group of a member. But there is no endpoint to edit or add access groups to a target member.

    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 →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  10. Contact Webhooks

    How to get whether or not a contact or member was deleted using webhooks without running too many api calls. Could there be an upgrade to the contacts webhooks and return 'Action' similar to events or that of membership?

    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)
  11. Contacts API: filter non-members

    How do I access non-members using the Contacts API. I have already tried '&$filter=Member ne true' but that seems to just return a list of all the contacts including members that have a membership associated to their account.

    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

    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)
  12. 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…

    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

    3 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. contact/me does not return an "Organization"

    I am using accounts/{accountId}/contacts/me endpoint to get details for the currently-logged in user. The API documents there should be an "Organization" in the response. However, this field is always null/the empty string. Is there a way to get this information?

    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)
  14. Contacts API returns incorrect Profile Last Updated

    I recently (2021-12-19) suspended and archived a member (ID 57031785). The contacts API is still returning the timestamp of the previous update (2021-06-18T10:58:17.37-07:00) for Profile Last Updated.

    This invalidates any API usage that seeks to minimize server load and response time by fetching only changed records.

    I believe this is a bug, and it prevents me from using the Contacts API effectively. I will have to do a full contacts dump every time I want to synchronize my local DB, and will increase the load on your server significantly, since this is done at least once a day, sometimes more…

    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. Contact API sort options

    Currently the Contact API supports Name or MemberSince order. For the purposes of synching an external database efficiently, it would be really nice to add a sort by contact ID

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

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  17. 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)
    Dmitry Smirnov responded

    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’

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

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  19. 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 →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  20. 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…

    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

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

Developers

Categories

Feedback and Knowledge Base