Home

Download this help site
(PDF 82MB)

Download

SavedSearches API V2 call

Icon

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.

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.

Retrieving information for a particular saved search

Syntax

Example

Retrieving information for all saved searches

Syntax

Example

Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

Parameters

The following parameters are used within the SavedSearches API call:

Variable

Description

{baseAPIaddress}

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

{accountID}

The account identifier that appears on the Account and billing screen and 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.

Field

Description

IsBuiltInIndicates whether the search is a built-in system search that cannot be modified or deleted.
ContactIDsThe contact IDs of contacts that match the search criteria. Contact IDs are only returned when retrieving information for a specific saved search.
IDThe unique identifier of the search.
URLThe address of the API call for this search.
NameThe name assigned to the saved search.

Sample JSON response

Sample XML response

On this page:   

See also:

  • No labels