/bff/person/search

Searches organisation contacts by name, email, or phone. Alternatively resolves specific contacts by their external IDs. Returns matching persons with avatar and activity information when available.

PersongetBffPersonSearch

Parameters

2 query

2 total

Query · 2

querystring

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

idsstring

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

Request

GET /bff/person/search

get

curl -X GET "https://api.bizkithub.com/bff/person/search?query=jan&ids=1cGIHvFoQDGLAbcA%2C1cGshrhn5DGLAbcA" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "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"
        }
      }
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key