Contacts

Get Contact

Retrieve contact information for a given number.

get/contacts

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/contacts
  • Auth: API key in header PINNACLE-API-KEY

Query parameters

idstring

Unique identifier of a specific contact you want to retrieve. <br>

Either this parameter or phoneNumber must be provided, but not both.

phoneNumberstring

Phone number you want to look up contact information for, provided in URL-encoded E.164 format with %2B prefix instead of +.

Response

Successfully retrieved.

descriptionstring

Additional information about the contact.

emailstring

Contact's email address, if available.

idstring required

Unique ID of the contact. This identifier is a string that always begins with the prefix co_, for example: co_1234567890.

namestring

Full name of the contact, if available.

phoneNumberstring required

Contact's phone number in E.164 format.

tagsstring[]

List of tags associated with the contact.

Changes

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