Get Contact Card | Pinnacle

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.tools.contactCard.get({
        id: "cc_1234567890",
    });
}
main();

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

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.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

idstringRequired

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

optionsobjectOptional

Response

Returns complete contact information.

addresseslist of objects

Physical addresses.

categorieslist of strings

Categories or tags for organizing contacts.

emailslist of objects

Email addresses.

fileobject

File associated to the contact.

formattedNamestring

Full display name for the vCard.

idstring

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

nameobject

Structured name components.

phoneslist of objects

Phone numbers.

revisionstring

ISO 8601 timestamp of last vCard update.

birthdaystring or nullOptional

Birthday in ISO 8601 date format (YYYY-MM-DD).

geoobject or nullOptional

Geographic coordinates.

nicknamelist of stringsOptional

Nicknames or aliases.

notestring or nullOptional

Additional notes or comments.

organizationobjectOptional

Organization or company information.

rolestring or nullOptional

Role or function within the organization.

timezonestring or nullOptional

Timezone (e.g., “America/New_York”).

titlestring or nullOptional

Job title or position.

urlstring or nullOptional

Website URL.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error