Get Contact

This API endpoint allows you to retrieve a contact, based on their phone number or email address.

Authentication:
This endpoint requires an API key for authentication. You need to include the API key in your request.

Request:
This is a GET request. You can search for a contact by either phone number or email address, but not both at the same time. Here are the accepted query parameters:

  • email (Optional): The email address of the contact you want to retrieve.
  • phoneNumber (Optional): The phone number of the contact you want to retrieve. Include the country code without the plus sign (e.g., "1234567890" for a US number).

Additional Notes:

  • You cannot search for a contact using both phone number and email at the same time. Only provide one or the other parameter in your request.
  • If the phone number is provided, it will be formatted by adding a plus sign "+" before the country code for internal processing.
Language
Credentials
Query
Click Try It! to start a request and see the response here!