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. New contacts are visible to every active agent by default (a wildcard access row is seeded on create); narrow visibility by granting or revoking specific identities under Access control.
API base URL:
https://inkbox.ai/api/v1/contactsQuick start
Create an account and get your API key from the Inkbox console:
Get API keyAll contact API requests require authentication with an API key or Clerk JWT. Read endpoints accept admin API keys, claimed agent API keys, and Clerk JWT; unclaimed (mid-signup) agent keys are rejected. Grants to specific identities (POST .../access with an identity_id) are admin + JWT only.
X-API-Key: YOUR_API_KEYContacts
Create contact
POSTCreate a new contact in your organization
/api/v1/contactsList contacts
GETList contacts with optional substring search
/api/v1/contactsGet contact
GETGet a single contact by ID
/api/v1/contacts/{contact_id}Lookup contact
GETReverse-lookup contacts by email, domain, or phone
/api/v1/contacts/lookupUpdate contact
PATCHUpdate a contact with JSON-merge-patch semantics
/api/v1/contacts/{contact_id}Delete contact
DELETEDelete a contact
/api/v1/contacts/{contact_id}Access control
Grant identity access
POSTGrant an identity access, or reset the contact to the wildcard default
/api/v1/contacts/{contact_id}/accessList access rules
GETList wildcard or per-identity access rows for a contact
/api/v1/contacts/{contact_id}/accessRevoke identity access
DELETERevoke an identity's access (materializes wildcard first if needed)
/api/v1/contacts/{contact_id}/access/{identity_id}vCards
Import vCards
POSTBulk-import a vCard stream (up to 1000 cards per request)
/api/v1/contacts/importExport vCard
GETDownload a single contact as a .vcf file
/api/v1/contacts/{contact_id}.vcf