Get a contact

Looks up one contact by phone number or email. Send the phone number with its country code and without the leading +.

GET

https://api.zacx.io/v1/contact

View as Markdown

Authorisation

bearerAuthHTTPrequired

Query parameters

phoneNumberoptionalstring
The contact's phone number with country code, without +.
emailoptionalstring
The contact's email address.

format: email

Returns

200

The contact.

JSON

dataobjectrequired
6 properties
- nameoptionalstring
- emailoptionalstring
  format: email
- phoneoptionalstring
  Phone number with country code.
  
  Example: "919999999999"
- customFieldsoptionalarray ofobject
  2 properties
  nameoptionalstring
  Example: "test field"
  valueoptionalstring
  Example: "custom field value"
- tagsoptionalarray ofstring
- assignedUsersoptionalarray ofobject
  3 properties
  nameoptionalstring
  Example: "Meta Inc"
  phoneNumberoptionalstring
  Example: "+918989898989"
  emailoptionalstring
  format: email
  Example: "[email protected]"

400

The phone number is not in a valid format.

JSON

statusstringrequired
codestringrequired
Stable machine-readable error code.
messagestringrequired
Human-readable explanation.

404

No contact matches the given identifier.

JSON

statusstringrequired
codestringrequired
Stable machine-readable error code.
messagestringrequired
Human-readable explanation.

{ "data": { "name": "Testing Contact", "email": "[email protected]", "phone": "919999999999", "customFields": [ { "name": "test field", "value": "custom field value" } ], "tags": [ "test-tag" ], "assignedUsers": [ { "name": "Meta Inc", "phoneNumber": "+918989898989", "email": "[email protected]" } ] } }