Skip to main content

SearchContact finds a contact by phone or email.

POST 

/api/v1/engagements/contacts/search

Useful for screen pops during inbound calls.

Parameters​

  • phone_number: Optional, search by phone
  • email: Optional, search by email

Response​

Returns the first matching contact.

Errors​

  • NOT_FOUND: No matching contact found
  • PERMISSION_DENIED: Caller lacks contacts:read permission

Request​

Responses​

A successful response.