CustomerSearch (
    string Field,
    string Search 
)

Returns a list of customers matching the search criteria.

Request

Request Data:

  • (string) Field (optional) identify which custom field to search on. If not provided, the name of the customer is used.
  • (string) Search (required) string to match for.
{
    "Field" : <string>,
    "Search": <string>
}

Response

{
    "Result": {
        "Search": <string>,
        "Field": <string>,
        "Results": [
            {
                "Name": <string>,
                "ID": <int>
            },
            ... more customers
        ]
    }
}

Errors

  • “Field not found” – If the provided field name does not exist.
  • "Call requires parameter: \"Search\" which was not found"
  • "No search term was provided"