Skip to content

Jump to

Contacts API

An organization-wide address book shared across every agent in your org. Each contact aggregates names, emails, phones, addresses, websites, and arbitrary custom fields. Every contact is visible to every active agent in the organization.

API base URL:

https://inkbox.ai/api/v1/contacts

Quick start

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

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.

X-API-Key: YOUR_API_KEY

Contacts

Create contact

Create a new contact in your organization

/api/v1/contacts

List contacts

List contacts with optional substring search

/api/v1/contacts

Get contact

Get a single contact by ID

/api/v1/contacts/{contact_id}

Lookup contact

Reverse-lookup contacts by email, domain, or phone

/api/v1/contacts/lookup

Update contact

Update a contact with JSON-merge-patch semantics

/api/v1/contacts/{contact_id}

Delete contact

Delete a contact

/api/v1/contacts/{contact_id}

Memory and correspondence

List correspondence

Read email, SMS, iMessage, and call history for a contact

/api/v1/contacts/{contact_id}/correspondence

List contact facts

List active generated memories and their citations

/api/v1/contacts/{contact_id}/facts

Delete contact fact

Delete a generated memory and return the remaining memory state

/api/v1/contacts/{contact_id}/facts/{fact_id}

Merge contacts

Merge duplicate contacts and their memories

/api/v1/contacts/{contact_id}/merge

vCards

Import vCards

Bulk-import a vCard stream (up to 1000 cards per request)

/api/v1/contacts/import

Export vCard

Download a single contact as a .vcf file

/api/v1/contacts/{contact_id}.vcf

Additional resources