Get Contact API Reference

Serverhttps://api.pinnacle.sh/

Retrieve contact information for a given number.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Query Parameters

idstringOptional

Unique identifier of a specific contact you want to retrieve.

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

Example

"resource_01J8K3R7M9"

phoneNumberstringOptional

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

Match

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

Example

"%2B14155550142"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.contacts.get({
    id: "co_1234567890"
});

Responses

{  "id": "co_1234567890",  "phoneNumber": "+14154537890",  "name": "Alva Roope",  "email": "alvaroope@pinnacle.sh",  "tags": [    "friend",    "work"  ],  "description": "Friend from work"}

Get Contact

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`