Skip to main content
A shared organization address book containing names, emails, phones, addresses, websites, and custom fields. Contact access separates whole-group email/phone visibility from per-address communication. Profile is the parent permission for all contact data, including Memories. Hosted voice in YOLO mode retains full organization contact access. Receiving and sending permissions are independent. inbound_contactable and outbound_contactable describe each side; legacy contactable reads mean can send, while legacy writes still set both sides. Permission in either direction can make an address group visible, subject to explicit visibility and Profile restrictions. Directional SDK/CLI options require 0.7.3 or later. See receive-only access. API base URL:

​
Quick start

Create an account and get your API key from the Inkbox console:

Get API key

All contact API requests require an API key. Read endpoints accept admin API keys and claimed agent API keys; unclaimed (mid-signup) agent keys are rejected.

​
Contacts

Create contact

Create a new contact in your organizationPOST /api/v1/contacts

List contacts

List contacts with optional substring searchGET /api/v1/contacts

Get contact

Get a single contact by IDGET /api/v1/contacts/{contact_id}

Lookup contact

Reverse-lookup contacts by email, domain, or phoneGET /api/v1/contacts/lookup

Update contact

Update a contact with JSON-merge-patch semanticsPATCH /api/v1/contacts/{contact_id}

Delete contact

Delete a contactDELETE /api/v1/contacts/{contact_id}

​
Memory and correspondence

List correspondence

Read email, SMS, iMessage, call, and Slack history for a contactGET /api/v1/contacts/{contact_id}/correspondence

List contact facts

List a contact’s memories, their kinds, and their citationsGET /api/v1/contacts/{contact_id}/facts

Add contact fact

Record a memory by hand as profile, preference, or contextPOST /api/v1/contacts/{contact_id}/facts

Edit contact fact

Correct a memory’s wording or move it to a different kindPATCH /api/v1/contacts/{contact_id}/facts/{fact_id}

Delete contact fact

Delete a memory and return the remaining memory stateDELETE /api/v1/contacts/{contact_id}/facts/{fact_id}

Merge contacts

Merge duplicate contacts and their memoriesPOST /api/v1/contacts/{contact_id}/merge

​
vCards

Preview an import

Check a vCard batch for conflicts before importingPOST /api/v1/contacts/import/preview

Import vCards

Bulk-import a vCard stream (up to 10 MiB and 2,500 cards per request)POST /api/v1/contacts/import

Export multiple contacts

Export up to 25 contacts in one vCard documentPOST /api/v1/contacts/vcard-export

Export vCard

Download a single contact as a .vcf fileGET /api/v1/contacts/{contact_id}.vcf

​
Additional resources