BizKitHub
DocsAPI ReferenceContact/bff/contact/find-or-create-by-email
postContactAdmin BFF

/bff/contact/find-or-create-by-email

Normalizes the e-mail via the canonical normalizeContactEmail helper (same rules as unique-index enforcement), looks the contact up within the current organisation, and returns it if found. Otherwise creates a minimal contact with just the e-mail and returns the new row. Used by the issue-reporter quick-add flow so an e-mail typed into the picker becomes a real shop__contact in one click without opening the full contact-registration modal.

ContactpostBffContactFind-or-create-by-email

Parameters

JSON body

Request body

application/json
emailstringRequired

Contact email address.

The system validates the input as a standard email address and automatically applies normalization and canonicalization.

All API responses return the normalized form, and each email address is unique per organisation within the system.

Phone-only contacts: Since 2026-06-10 a contact may exist without an e-mail when it was registered only by phone (e.g. imports of phone-only records). Responses that expose such contacts use API_EMAIL_NULLABLE instead, where this field can be null. Endpoints that accept e-mail as input still require a valid value here — phone-only creation goes through admin-only import / BFF flows.

Examplejan@barasek.com

Response schema

1 status code documented

200Success
idnumberRequired

Numeric contact id (customerId).

namestringRequired

Human display name — from first/last name, beautified e-mail local-part, or the raw address.

emailstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
createdbooleanRequired

true when a new contact was inserted; false when an existing one was returned.

Response example

application/json
{
  "id": 0,
  "name": "example_name",
  "created": false
}

Request example

POST /bff/contact/find-or-create-by-email

post
curl -X POST "https://api.bizkithub.com/bff/contact/find-or-create-by-email" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "email": "jan@barasek.com"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key