Skip to main content

​
MCP tool: filter_customer_contacts_by_ids

Filters customer contacts based on a list of contact IDs. This tool is useful for retrieving specific contacts when you have their IDs, or for bulk operations on a set of known contacts.

​
Example prompt

Filter customer contacts by IDs ["CONTACT001", "CONTACT002", "CONTACT003"]

​
Input parameters

NameTypeRequiredDescription
idsstring[]YesList of customer contact IDs to filter by

​
Response fields

Below are the fields you may see in each customer contact object in the response:
FieldTypeDescription
idstringUnique identifier of the customer contact
firstNamestringFirst name of the customer contact
lastNamestringLast name of the customer contact
emailstringEmail address of the customer contact
phoneNumberstringPhone number of the customer contact
avatarUrlstringAvatar URL of the customer contact
accountsarrayArray of associated accounts with id and name
contactTypeIdstringID of the contact type
contactTypestringName of the contact type (e.g., “Decision Maker”)
customFieldValuesarrayCustom field values for the contact
metadataobjectAdditional metadata for the contact
createdAtstring (ISO8601)Creation timestamp
updatedAtstring (ISO8601)Last update timestamp

​
Sample response

{
  "data": [
    {
      "id": "CONTACT001",
      "firstName": "John",
      "lastName": "Smith",
      "email": "john.smith@acme.com",
      "phoneNumber": "+1-555-0123",
      "avatarUrl": "https://example.com/avatar.jpg",
      "accounts": [
        {
          "id": "ACC001",
          "name": "Acme Corporation"
        }
      ],
      "contactTypeId": "TYPE001",
      "contactType": "Decision Maker",
      "customFieldValues": [
        {
          "customFieldId": "CUSTOM001",
          "data": "Senior Manager",
          "metadata": {}
        }
      ],
      "metadata": {
        "department": "Engineering",
        "lastContactDate": "2025-07-24T10:00:00Z"
      },
      "createdAt": "2025-07-24T07:19:10.258Z",
      "updatedAt": "2025-07-24T07:19:10.258Z"
    },
    {
      "id": "CONTACT002",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@acme.com",
      "phoneNumber": "+1-555-0456",
      "avatarUrl": "https://example.com/jane-avatar.jpg",
      "accounts": [
        {
          "id": "ACC001",
          "name": "Acme Corporation"
        }
      ],
      "contactTypeId": "TYPE002",
      "contactType": "Technical Contact",
      "customFieldValues": [],
      "metadata": {
        "department": "IT",
        "lastContactDate": "2025-07-23T14:30:00Z"
      },
      "createdAt": "2025-07-24T08:19:10.258Z",
      "updatedAt": "2025-07-24T08:19:10.258Z"
    }
  ],
  "status": true,
  "message": "Customer contacts filtered successfully!",
  "timestamp": "2025-07-25T12:50:38.937Z"
}