Skip to content

Find contacts by name

GET /custom/contact/search

Searches CRM contacts by display name through the connector's optional findContactWithName capability. The returned contact array can include connector-specific fields, and connector-level failure can be represented by successful: false.

Operation ID: getCustomContactSearch
Authorization: BEARER or API key

Parameters

Name Location Type Required Description
name query string Yes CRM contact name search text.

Responses

Status Description Body
200 Matching CRM contacts. ContactSearchResponse
400 Bad request, missing authentication, or connector error. ErrorResponse, string
401 The user session is expired or revoked. ErrorResponse, string