Get Contacts | Pinnacle | Documentation

Retrieve contact information for a given number.

PINNACLE-API-KEYstring

API Key authentication via header

idstringOptional

Unique identifier of a specific contact you want to retrieve.

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

phoneNumberstringOptionalformat: "^%2B[1-9]\d{1,14}$"

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

Successfully retrieved.

idstring

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

phoneNumberstring

Contact's phone number in E.164 format.

descriptionstring or null

Additional information about the contact.

emailstring or null

Contact's email address, if available.

namestring or null

Full name of the contact, if available.

tagslist of strings or null

List of tags associated with the contact.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.contacts.get({
8	id: "co_1234567890",
9	});
10	}
11	main();

1	{
2	"id": "co_1234567890",
3	"phoneNumber": "+14154537890",
4	"description": "Friend from work",
5	"email": "alvaroope@pinnacle.sh",
6	"name": "Alva Roope",
7	"tags": [
8	"friend",
9	"work"
10	]
11	}