Usage

Use Search to search for specified objects.

General Syntax

SearchResultArray = cventapi.Search(CvObjectType ObjectType, CvSearchObject CvSearchObject)

Input

NameTypeDescription
ObjectTypeCvObject TypeObject from which to retrieve data.
CvSearchObjectCvSearch ObjectA Cvent Search object that defines the parameters of the given search. The parameters supplied must match the valid parameters for the supplied ObjectType.

Output

NameTypeDescription
IdID ArrayArray of one or more object IDs that meet the search parameters supplied.

Notes

Take into account the following notes when using the Search call:

  • Maximum Number of Search Filters Passed: You can pass up to 256 search filters in a single search call. If a search request exceeds 256 search filters, then the entire operation fails.
  • Searching on Custom Fields: Event and Contact custom fields are searchable using this method. To search on a custom field, the field parameter in the CvSearchObject must match the following format and include the custom field ID:
    • Event Custom Field: CustomEventField:<FieldId>
    • Contact Custom Field: CustomContactField:<FieldId>
    • Session Custom Field: CustomSessionField:<FieldId>
    • BudgetItem Custom Field: CustomBudgetItemField:<FieldId>
Last updated on