Contacts

Find a contact

Looks up a single contact by exactly one of email address, phone number, or external ID and returns null when no contact matches. A phone number without + is read in the organization's default region.

post/v1/contacts/find

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/contacts/find
  • Auth: API key in header x-api-key

Request body

namespaceIdstring
emailstring nullable
phonestring nullable
externalIdstring nullable

Response

Success

idstring required
namespaceIdstring required
namestring required
displayNamestring nullable required
avatarstring nullable required
status'active' | 'paused' | 'blocked' | 'archived' required
statusReasonstring nullable required
externalIdstring nullable required
tagsstring[] required
metadataJsonObject required
createdAtstring required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.