Follow

SavedSearches API call

You can use the SavedSearches API call to retrieve information about saved contact searches or saved member searches. You can retrieve information for all saved searches, and just for a particular search.

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

Retrieving information for a particular saved search

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/SavedSearches/[searchID]
Example
GET https://api.wildapricot.org/v2/Accounts/58293/SavedSearches/238

Retrieving information for all saved searches

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/SavedSearches
Example
GET https://api.wildapricot.org/v2/Accounts/58293/SavedSearches
Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see API access options.

Parameters

The following parameters are used within the SavedSearches API call:

baseAPIaddress
The base address of the API. For more information, see API access options.

accountID
The account identifier that is returned by the Accounts API call.

searchID
The unique identifier of a saved search. Search IDs are returned by the SavedSearches API call.

Response fields

For each saved search, the SavedSearches API call retrieves the following information.

ContactIDs
The contact IDs of contacts that match the search criteria. Contact IDs are only returned when retrieving information for a specific saved search.

ID
The unique identifier of the search.

IsBuiltIn
Indicates whether the search is a built-in system search that cannot be modified or deleted.

Name
The name assigned to the saved search.

URL
The address of the API call for this search.

Sample JSON response

[
{
"IsBuiltIn": false,
"Id": 240,
"Url": "http://api.wildapricot.org/v2/accounts/42353/SavedSearches/240",
"Name": "Active NY members"
},
{
"IsBuiltIn": false,
"Id": 241,
"Url": "http://api.wildapricot.org/v2/accounts/42353/SavedSearches/241",
"Name": "Platinum pending renewal"
}
]

Sample XML response

<ArrayOfSavedSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bonasource.MembershipFS.PublicAPI.Model.V2.Contacts">
<SavedSearch>
<Id xmlns="http://api.wildapricot.org">240</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/SavedSearches/240</Url>
<Name xmlns="http://api.wildapricot.org">Active NY members</Name>
<ContactIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<IsBuiltIn>false</IsBuiltIn>
</SavedSearch>
<SavedSearch>
<Id xmlns="http://api.wildapricot.org">241</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/SavedSearches/241</Url>
<Name xmlns="http://api.wildapricot.org">Platinum pending renewal</Name>
<ContactIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<IsBuiltIn>false</IsBuiltIn>
</SavedSearch>
</ArrayOfSavedSearch>

0 Comments

Please sign in to leave a comment.

Search: WildApricot.com 

About results ( seconds) Sort by: 
Sorry, an error occured when performing search.