API ReferenceTools

Get Contact Card

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 null

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

geoobject or null
Geographic coordinates.
nicknamelist of strings or null
Nicknames or aliases.
notestring or null
Additional notes or comments.
organizationobject or null
Organization or company information.
rolestring or null
Role or function within the organization.
timezonestring or null

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

titlestring or null
Job title or position.
urlstring or null
Website URL.

Errors