MCP 207 tools

Browse the tools
Available tools

Contacts

A contact is a person you record. Each has a page of their own, shaped by a template, holding what you know about them.

Choose a tool to see the parameters it accepts.

Tools

List the contacts of one vault, a page at a time, optionally narrowed by a search, a grouping or contact categories. Each contact comes with the columns the vault shows in its list.

vault string required
The id of the vault, as list-vaults gives it.
query string optional
Words to search the contacts of the vault for.
filter string optional
Only the contacts of one grouping. One of: all, favourites, names-only
sort string optional
What the list is ordered by. One of: name, nickname, last-spoke, added
direction string optional
The direction of the order. One of: asc, desc
categories array optional
The ids of contact categories, as list-contact-categories gives them; only the people holding any of them.
page integer optional
The page to read, starting at 1.
per_page integer optional
How many contacts a page holds: 25 unless asked, 100 at most.

List the contact categories held by the contacts of a vault, with how many contacts hold each. The id of a category is what list-contacts takes in categories.

vault string required
The id of the vault, as list-vaults gives it.
filter string optional
Count only the contacts of one grouping, as list-contacts narrows them. Every contact when left out. One of: all, favourites, names-only

Look one contact up in a vault.

vault string required
The id of the vault, as list-vaults gives it.
contact string required
The id of the contact, as list-contacts gives it.

Return everything recorded about one contact as a single Markdown document: names, fields, relationships, life events, groups, reminders and loans. The values of sensitive fields are given only to a key holding the sensitive fields scope. The export is written to the account log.

vault string required
The id of the vault, as list-vaults gives it.
contact string required
The id of the contact, as list-contacts gives it.

Look up the contact that stands for the account holder in a vault.

vault string required
The id of the vault, as list-vaults gives it.

List every way the name of a contact is written: in its own script, transliterated, or as it is pronounced, and which one it is shown under.

vault string required
The id of the vault, as list-vaults gives it.
contact string required
The id of the contact, as list-contacts gives it.

Record a new contact in a vault. The change is written to the account log.

vault string required
The id of the vault, as list-vaults gives it.
first_name string required
Their given name, the one part a contact cannot go without.
prefix string optional
What comes before the name, such as Dr.
middle_name string optional
Their middle name.
last_name string optional
Their family name.
suffix string optional
What comes after the name, such as Jr.
maiden_name string optional
Their name before marriage.
nickname string optional
What they are actually called.
name_order string optional
Which part of the name reads first. Left out, the reader decides. One of: given_first, family_first
is_partial boolean optional
True for somebody you know of rather than somebody you have written down. A partial contact is off every list until they are more than a first name. False when left out.
is_favourite boolean optional
True to put the contact at the top of the list. False when left out.
structure_version_id integer optional
The id of the published version of one of your active contact templates, as list-template-versions gives it, which says what the page of the contact holds. Left out, the contact starts from the template the vault uses for new contacts.

Correct the name of a contact. The change is written to the account log.

vault string required
The id of the vault, as list-vaults gives it.
contact string required
The id of the contact, as list-contacts gives it.
prefix string optional
What comes before the name, such as Dr.
first_name string optional
Their given name.
middle_name string optional
Their middle name.
last_name string optional
Their family name.
suffix string optional
What comes after the name, such as Jr.
maiden_name string optional
Their name before marriage.
nickname string optional
What they are actually called.
name_order string optional
Which part of the name reads first. One of: given_first, family_first

Replace every way the name of a contact is written, and choose the one it is shown under. A way left out of the list is deleted. Nothing is transliterated for you. The change is written to the account log.

vault string required
The id of the vault, as list-vaults gives it.
contact string required
The id of the contact, as list-contacts gives it.
name_representations array optional
Every way the name is written, in order. Each: id (to keep an existing one, as list-contact-name-representations gives it), kind (written, transliteration or phonetic), language (a BCP 47 tag such as ko), script (an ISO 15924 code such as Hang or Latn), phonetic_system (required for phonetic, such as ipa or piny), formatted_name, prefix, given_name, additional_name, family_name, suffix, name_order (given_first or family_first). Each needs a formatted_name or at least one part. A phonetic one holds parts only, never a formatted_name, and cannot be the one displayed.
display integer optional
The position in name_representations, from 0, of the way the contact is shown under. Required with name_representations, unless that list is empty.
nickname string optional
What they are actually called.
maiden_name string optional
Their name before marriage.

Mark a contact as a favourite, or stop marking them one.

vault string required
The id of the vault, as list-vaults gives it.
contact string required
The id of the contact, as list-contacts gives it.
favourite boolean required
True to mark them a favourite, false to stop.