Get Contact Card API Reference

Serverhttps://api.pinnacle.sh/

Retrieve contact information as a vCard and get a presigned URL to download the file. Contact cards can be sent via MMS as a media file.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idstring

The unique identifier of the contact. This identifier is a string that always begins with the prefix cc_, for example: cc_1234567890.

Example

"contact_01J8K3R7M9"

objectOptional

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

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

await client.tools.contactCard.get({
    id: "cc_1234567890"
});

Responses

{  "id": "cc_1234567890",  "formattedName": "Porter",  "name": {    "familyName": "Porter",    "givenName": "Liam",    "additionalNames": [      "Liam Porter"    ],    "honorificPrefixes": [      "Mr"    ],    "honorificSuffixes": []  },  "addresses": [],  "phones": [],  "emails": [],  "categories": [],  "revision": "2025-08-15T18:35:42.538+00:00",  "file": {    "url": "https://server.pinnacle.sh//storage/v1/example",    "metadata": {      "expiresAt": null    }  }}

Get Contact Card

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Get Contact Card

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`