tools > contactCard

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.

post/tools/contact-card

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/tools/contact-card
  • Auth: API key in header PINNACLE-API-KEY

Request body

idstring required

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

Response

Returns complete contact information.

idstring required

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

formattedNamestring required

Full display name for the vCard.

nicknamestring[]

Nicknames or aliases.

birthdaystring nullable

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

urlstring nullable

Website URL.

timezonestring nullable

Timezone (e.g., "America/New_York").

titlestring nullable

Job title or position.

rolestring nullable

Role or function within the organization.

categoriesstring[] required

Categories or tags for organizing contacts.

notestring nullable

Additional notes or comments.

revisionstring required

ISO 8601 timestamp of last vCard update.

Changes

No recorded changes to this operation across all 1 revision of this API.