BizKitHub Developer Documentation

Parameters

2 query

Query parameters

· 2

querystringOptional

Free-text search query (name, email, or phone).

Examplejan

idsstringOptional

Comma-separated list of cuRefNo IDs used to resolve persons.

Example1cGIHvFoQDGLAbcA,1cGshrhn5DGLAbcA

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

idstringRequired

Customer external ID (cuRefNo).

namestringRequired

Full name of the person.

ExampleJan Barášek

memberIdnumberOptional

Organisation member ID, if the person is a member.

customerIdnumberOptional

Customer record ID, if the person is a customer.

emailstringOptional

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

phonestringOptional

Contact phone number in international (national) format.

Preferred format: +<country_code> <local_number>

Leading plus sign (+) is required
Followed by the country calling code (e.g. 420)
One space after the country code
Full local number without spaces

Example: +420 777123456
This format ensures unambiguous storage, validation, and compatibility with SMS, calling, and third-party integrations (e.g. Twilio, WhatsApp, CRM systems).

Example+420 777123456

avatarInfoobjectOptional

fullNamestringOptional

Display name for the avatar.

ExampleJan Barášek

avatarUrlstringOptional

URL of the avatar image.

Examplehttps://storage.xhp.cz/brj%2Favatar%2Fha70t7we3kvkkby5wcdv16m0r9fhjt24.jpg

activityInfoobjectOptional

statusstringOptional

Online status flag ("t" = online, "f" = offline).

Examplef

inActiveMinutesnumberOptional

Minutes since last activity.

Example28.12595

lastActivityDate | string | string | numberOptional

Timestamp of last recorded activity.

One of 4:

Variant 1

Date

Timestamp of last recorded activity.

Example2025-01-10T16:19:40.150Z

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

Response example

application/json

{
  "items": [
    {
      "id": "example_id",
      "name": "Jan Barášek",
      "memberId": 0,
      "customerId": 0,
      "email": "jan@barasek.com",
      "phone": "+420 777123456",
      "avatarInfo": {
        "fullName": "Jan Barášek",
        "avatarUrl": "https://storage.xhp.cz/brj%2Favatar%2Fha70t7we3kvkkby5wcdv16m0r9fhjt24.jpg",
        "activityInfo": {
          "status": "f",
          "inActiveMinutes": 28.12595,
          "lastActivity": "2025-01-10T16:19:40.150Z"
        }
      }
    }
  ]
}

/bff/person/search