Customer Contacts
Filter customer contacts
Query customer contacts using flexible filter criteria with AND/OR logic.
By default, only non-deleted customer contacts are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria.
post/customer-contacts/filter
Request body
Example request
{
"filter": {
"and": [
{
"isPrimary": {
"equalTo": true
}
},
{
"contactTypes": {
"includes": "BILLING"
}
}
]
},
"pageSize": 50
}Response
Filtered customer contacts with pagination
Example response
{
"data": [
{
"object": "CUSTOMER_CONTACT",
"id": "550e8400-e29b-41d4-a716-446655440000",
"customer": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CUSTOMER-ACME",
"name": "Acme Manufacturing Corp",
"friendlyId": "A123456",
"status": "ACTIVE",
"phoneNumber": "+1-555-123-4567",
"website": "https://acme-manufacturing.com",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"name": "John Smith",
"contactInfo": {
"name": "John Smith",
"email": "john.smith@example.com",
"phoneNumber": "+1-555-0100",
"title": "Operations Manager"
},
"phoneExtension": "1234",
"isPrimary": true,
"contactTypes": [
"BILLING",
"ACCOUNT_MANAGER"
],
"notifications": [
"SHIPMENT_PICKED_UP",
"SHIPMENT_DELIVERED"
],
"invitedUser": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"deletedBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"key": "ERP-CONTACT-JOHN-001",
"createdAt": "2025-01-15T10:00:00Z"
}
],
"pageInfo": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}