115 results found

1. Events API documentation problems?

   I'm working with the Events API and find three aspects that don't work as documented:

   $count= parameter value

   The API returns a count regardless of the $count setting. In other words, either value, True or False, causes the API to return the count only. To get the actual events I have to completely omit the $count parameter. This is probably a bug with a simple workaround (omit the $count parameter). But see also my other post about a serious performance issue with $count.

   $async= parameter

   The Events API on Swaggerhub claims to support async operation, but the query is executed synchronously regardless of the value (True or False) or if the parameter is omitted. I presume this is just a documentation error.

   $filter= date comparison with 'le' operator

   Consider: $filter=EndDate ge 2026-02-23 and StartDate le 2026-02-24

   Given the definition of 'le' as 'less than or equal', you would expect the returned set to include events happening on 2026-02-24. In reality this behaves as if 'lt' was specified, returning only events on 2026-02-23.

   What I expect is happening is that, for the comparison, 2026-02-24 is being treated as a full datetime 2026-02-24T00:00:00, so the only events that would be included would be events starting at midnight. This probably needs a documentation update.

   I'm working with the Events API and find three aspects that don't work as documented:

   $count= parameter value

   The API returns a count regardless of the $count setting. In other words, either value, True or False, causes the API to return the count only. To get the actual events I have to completely omit the $count parameter. This is probably a bug with a simple workaround (omit the $count parameter). But see also my other post about a serious performance issue with $count.

   $async= parameter

   The Events API on Swaggerhub claims to support async operation, but the query is executed… more

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   0 comments  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

2. New API Pagination - Performance Degradation

   The pagination requirement in the upcoming API release requires multiple API calls in place of one.
   I did a test integration on one of our custom javascript operations that queries events and currently returns about 1300 records, which takes about 2 seconds (already slow by modern standards - by the way I am running a very fast internet connection). With the limitation of 100 records per query, it now requires 13 iterations at 2 seconds a piece for a total of just under 30 seconds. This is obviously unacceptable.
   I have attached a code snippet to illustration what I am doing.
   Unless I am doing something wrong, this will result in the Wild Apricot product being unusable.
   Have any other developers out there run into the issue?

   The pagination requirement in the upcoming API release requires multiple API calls in place of one.
   I did a test integration on one of our custom javascript operations that queries events and currently returns about 1300 records, which takes about 2 seconds (already slow by modern standards - by the way I am running a very fast internet connection). With the limitation of 100 records per query, it now requires 13 iterations at 2 seconds a piece for a total of just under 30 seconds. This is obviously unacceptable.
   I have attached a code snippet to illustration what I am… more

   • 

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   1 comment  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

3. Recreate the Members report via API?

   I looked all thru the API reference on swagger and the most likely place this data is being pulled is the the auditlog. I want to grab the member levels at the end of each month of a given date range. Is this possible via the API? Thanks!!

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   0 comments  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

4. API Timeout

   Hi, I have a script that fetches the contactId for each person in the database and then gets the details of each person. The rate limit for the "contact by identifier" is 120 per minute. I seem to be getting some time out errors every now and then. I am wondering if this is due to the rate limit. I have the request set for 2 requests per second. Sometimes after 600 records or so it starts to timeout. My script is set up to retry the ID after 5 seconds. It will go through a max of 3 retries and then skip the ID. It skips 3 IDs so that is 60 seconds of waiting. My question is, if the API rate limit is reached what is the penalty for hitting the rate limit? Is it a 60 second wait before the API will respond again? This would explain my time outs.

   Thanks!

   Hi, I have a script that fetches the contactId for each person in the database and then gets the details of each person. The rate limit for the "contact by identifier" is 120 per minute. I seem to be getting some time out errors every now and then. I am wondering if this is due to the rate limit. I have the request set for 2 requests per second. Sometimes after 600 records or so it starts to timeout. My script is set up to retry the ID after 5 seconds. It will go through a max of 3 retries… more

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   2 comments  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

5. Contacts API filter by FieldValues

   I want to be able to retrieve contacts based on the value of a custom contact field.

   I have been testing using the Swagger interface.

   The following filters return errors:

   Filter: member eq true and 'testfield' eq '12345'
   Filter: member eq true and testfield eq '12345'
   Error: Operator Equal is not supported for attribute testfield

   Filter: member eq true and substringof('testfield', '12345')
   Error: Operator Like is not supported for attribute testfield

   The 'testfield' attribute seems to be valid, however the filters are not supported.
   I could load all the contacts and filter them but isn't that wasting WA resources?

   Any tips on how to get this done?
   If this is not possible please let me know.

   Found the issue. The filters work if the field is text not a number.

   I want to be able to retrieve contacts based on the value of a custom contact field.

   I have been testing using the Swagger interface.

   The following filters return errors:

   Filter: member eq true and 'testfield' eq '12345'
   Filter: member eq true and testfield eq '12345'
   Error: Operator Equal is not supported for attribute testfield

   Filter: member eq true and substringof('testfield', '12345')
   Error: Operator Like is not supported for attribute testfield

   The 'testfield' attribute seems to be valid, however the filters are not supported.
   I could load all the contacts and filter them but isn't that wasting WA resources?

   Any… more

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   1 comment  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

6. Retrieve registrant AND guest data with single API call?

   I'm using the GET /accounts/{accountId}/eventregistrations API to retrieve the list of registrants. I also have a large number of guests. The only way to retrieve detailed guest info is to make individual calls to the registrant API, find whether they have any guests then make individual calls for each guest.

   Is there any way to use a single API call to retrieve all registrant and guest info in one call, to speed things up and make fewer calls, maybe using $filter? Based on the SWAGGER API reference it doesn't seem possible, but doesn't hurt to ask.

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   0 comments  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

7. Find events by API where reminder email schedules have not been set up

   We would like to find upcoming events where reminder e-mails have not been created. We find that we have a lot more no shows when that happens. Right now an admin has to go through and click on each event by name to see if this was done, and it is quite time consuming for our number of events. I have used the API successfully for other items; but I do not see the data attributes for the e-mail reminders in the API.

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   0 comments  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

8. Having trouble authenticating in Postman

   I'm working on authenticating in Postman for an upcoming project and this is what I'm sending:

   POST /auth/token HTTP/1.1
   Host: oauth.wildapricot.org
   Authorization: Basic {{API KEY GOES HERE}}
   Content-Type: application/x-www-form-urlencoded
   Content-Length: 40

   granttype=clientcredentials&scope=auto

   But I'm consistently getting a 401 Unauthorized error with this output:

   {
   "error": "invalidclient",
   "errordescription": null,
   "error_uri": null
   }

   I'm able to retrieve a token using the tool at https://api.wildapricot.org/ui/home/RequestOAuthToken and make calls using the API browser but, since I'm working on an integration with an existing application, I really need to be able to make a call on my own. Any hints on what I'm doing wrong here?

   I'm working on authenticating in Postman for an upcoming project and this is what I'm sending:

   POST /auth/token HTTP/1.1
   Host: oauth.wildapricot.org
   Authorization: Basic {{API KEY GOES HERE}}
   Content-Type: application/x-www-form-urlencoded
   Content-Length: 40

   granttype=clientcredentials&scope=auto

   But I'm consistently getting a 401 Unauthorized error with this output:

   {
   "error": "invalidclient",
   "errordescription": null,
   "error_uri": null
   }

   I'm able to retrieve a token using the tool at https://api.wildapricot.org/ui/home/RequestOAuthToken and make calls using the API browser but, since I'm working on an integration with an existing application, I really need to be able to make a call on my own. Any hints on… more

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   2 comments  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

9. Payment and invoice allocation

   I have posted some payments via the payments API with the following JSON:
   {
   "Value": 0.65,
   "DocumentDate": "2022-12-18",
   "Invoices": [ {"id": 002049} ],
   "Tender": {"id": 1038048},
   "Contact": {"id": 12345678},
   "Comment": "Test Payment to allocate to invoice",
   "PaymentType": "InvoicePayment"
   }
   The invoice number is correct (and has to be 0 justified otherwise the API fails), the payment is correctly entered in Wild Apricot but the response returns <AllocatedValue>0.0000</AllocatedValue>
   As a result, the payment needs to be manually settled in Wild Apricot against that same invoice.
   I expected the provision of the invoice number would automatically settle the payment. Did I miss something?
   I then tried to settle the payment using the AllocateInvoice API using the following:
   https://api.wildapricot.org/v2.2/accounts/123456/payments/12345678/AllocateInvoice
   where the accountId and paymentId are valid (i.e., the paymentId is the one returned by the payments API)
   The JSON is (the invoiceId must NOT be 0 justified or the validation fails) :
   {
   "InvoiceId": 2049,
   "Amount": 0.65
   }
   I get a status 400 with the following message: Invalid argument value: 'document'=12345678
   Which seems to say it does not recognise the paymentId it just created (or older ones for that matter).
   Did I miss something again or are there bugs in the APIs?
   Thank you to anyone who can help me with these problems.

   I have posted some payments via the payments API with the following JSON:
   {
   "Value": 0.65,
   "DocumentDate": "2022-12-18",
   "Invoices": [ {"id": 002049} ],
   "Tender": {"id": 1038048},
   "Contact": {"id": 12345678},
   "Comment": "Test Payment to allocate to invoice",
   "PaymentType": "InvoicePayment"
   }
   The invoice number is correct (and has to be 0 justified otherwise the API fails), the payment is correctly entered in Wild Apricot but the response returns <AllocatedValue>0.0000</AllocatedValue>
   As a result, the payment needs to be manually settled in Wild Apricot against that same invoice.
   I expected the provision of the invoice number would automatically settle the payment. Did I miss… more

   2 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   1 comment  ·  API  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Submit Rating

10. 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?

    2 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

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

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    4 comments  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

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

    2 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

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

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

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

    2 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

15. 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 Complete or Waiting with a resultUrl. Because cURL thinks it got a response, my code moves on.

    Using PHP, what is your recommended way of continuing to poll the API until the dataset is ready and retrieved? Sleep for a few seconds then use the ::makeRequest() method on the ResultUrl? I'd love to see some official recommendations for what to do in instances where your API needs more time.

    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… more

    2 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    3 comments  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

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

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

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

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    9 comments  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

18. API Send Email - Cannot specify Reply to Address

    I have been able to create and send emails via the API using a POST to /rpc/{accountId}/email/SendEmail. However, I have not found a way to change the default reply to address (the default is support@wildapricot.com).
    Is there a way to specify a Reply To address similar to the option available when drafting an email on the website?
    Thanks, Paul

    2 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

19. Check in member to an event using event registrations API

    Knowing the eventID and memberID, it would be ideal if the API could allow me to check that member into that eventregistation.

    2 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating

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

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    21 comments  ·  API  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Submit Rating