General information on search

In the response, the data comes in one array. On its Count key, the number of results can be found. On the Results key, the items can be found in separate arrays. Search results contain basic information about the found entities. Use the Url field to access all details through API. One page contains 100 results. You can request further hits using the Page parameter:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?Query=Test&Page=1

Paging starts at 0 so the second page can be accessed with Page=1.

In case of field-based search, UpdatedSince parameter helps you to find entities that were updated after a specific date.

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?StatusId=2500&UpdatedSince=2013-03-01+12:00:00

Project search (full-text)

Identification is required, example url:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?Query=Test

In this case, the search is only carried out among the Projects. The system searches those projects that are relevant based on the word.

Example output

{
  "Count": 1,
  "Results": {
    "1234": {
      "Id": "1234",
      "Name": "Test project",
      "Url": "https://r3.minicrm.hu/Api/R3/Project/1234",
      "StatusId": "2500",
      "UserId": "3200",
      "Deleted": "0"
    }
  }
}

Contact search (full-text)

Identification required, example url:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Contact?Query=John

In this case, the search is only carried out among the Contacts. The system searches those projects that are relevant based on the word. This type of search is recommended to search phone numbers. If you want to look up contacts with a specific phone number, please use numbers only. You have to provide at least the last 6 digits of the phone number. Example:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Contact?Query=2345678

Example output:

{
  "Count": 1,
  "Results": {
    "12345": {
      "Id": "12345",
      "Name": "John Doe",
      "Url": "https://r3.minicrm.hu/Api/R3/Contact/12345",
      "Type": "Person",
      "Email": "jd@example.com",
      "Phone": "0612345678"
    }
  }
}