Find all Contacts that match, fully or partially, the given search parameters

POST

/api/Contact/Search

POST

/api/Contact/Search

curl -X POST "https://api.virtuoussoftware.com/api/Contact/Search?skip=1&take=1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "search": "Weyland"
}'

200Contacts and Individuals_findAllContactsThatMatchFullyOrPartiallyTheGivenSearchParameters_example

{
  "list": [
    {
      "individualId": 1123,
      "name": "Charles Bishop Weyland",
      "id": 1111,
      "contactType": "Organization",
      "contactName": "Weyland-Yutani Corporation",
      "address": "Tokyo, Japan",
      "email": "inquiries@weyland-yutani.com",
      "phone": "800-555-1234",
      "contactViewUrl": "https://api.virtuoussoftware.com/api/Contact/1111"
    },
    {
      "individualId": 1344,
      "name": "Carter Burke",
      "id": 1233,
      "contactType": "Household",
      "contactName": "Carter Burke",
      "email": "carter.burke@weyland-yutani.com",
      "phone": "623-555-2933",
      "contactViewUrl": "https://api.virtuoussoftware.com/api/Contact/1233"
    }
  ],
  "total": 2
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10.

Request

This endpoint expects an object.

searchstringOptional

Response

listlist of objectsOptional

totalintegerOptional