/bff/contact/list

Returns a paginated list of contacts/customers with vitals, group membership, newsletter status, and CRM analytics. Supports full-text search, group filtering, and 10 attribute filters. All boolean filters use string values ("true"/"false"). Pagination via limit/page query params.

ContactgetBffContactList

Parameters

15 query

15 total

Query · 15

limitnumber

pagenumber

filterFulltextQuerystring

Full-text search across name, email, phone, and company name.

tagFilterstring

Comma-separated customer group slugs. Use "#-no-tags-#" for untagged contacts.

orderBystring

Sort field and direction. Format: "field:asc" or "field:desc".

isPremiumstring

Filter VIP/premium customers.

isBannedstring

Filter blocked/banned customers.

isRegisteredstring

Filter by registration status (has password = registered account).

isTestAccountstring

Filter test accounts. Use "false" to exclude them from reports.

hasCreditstring

Filter customers with positive credit balance ("true") or zero credit ("false").

localestring

Filter by customer locale.

registeredFromstring

Filter customers registered on or after this date (inclusive).

registeredTostring

Filter customers registered on or before this date (inclusive).

lastActivityFromstring

Filter customers active on or after this date. Use to find recently active or inactive users.

ignoreBulkMailstring

Filter by bulk email opt-out status. "true" = opted out, "false" = subscribed.

Request

GET /bff/contact/list

get

curl -X GET "https://api.bizkithub.com/bff/contact/list?limit=0&page=0&filterFulltextQuery=jan%40example.com&tagFilter=vip%2Cwholesale&orderBy=credit%3Adesc&isPremium=true&isBanned=true&isRegistered=true&isTestAccount=true&hasCredit=true&locale=cs&registeredFrom=2026-01-01&registeredTo=2026-01-31&lastActivityFrom=2026-01-01&ignoreBulkMail=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Paginated contact list with CRM analytics.

{
  "items": [
    {
      "id": "example_id",
      "name": "example_name",
      "firstName": "example_firstName",
      "lastName": "example_lastName",
      "companyName": "example_companyName",
      "isCompany": false,
      "companyRegistrationNumber": "example_companyRegistrationNumber",
      "taxIdentificationNumber": "example_taxIdentificationNumber",
      "isVatPayer": false,
      "isUnreliableVatPayer": false,
      "phone": "example_phone",
      "locale": "example_locale",
      "ignoreBulkMail": false,
      "testAccount": false,
      "premium": false,
      "ban": false,
      "registered": false,
      "credit": 0,
      "creditMoney": 0,
      "defaultOrderSale": 0,
      "subscriptionActiveCount": 0,
      "groupList": [
        {
          "slug": "example_slug",
          "name": "example_name",
          "color": "example_color",
          "count": 0
        }
      ],
      "avatarUrl": "example_avatarUrl",
      "internalNote": "example_internalNote",
      "accountAgeDays": 0,
      "monthLimitMaxCreditSpendHard": 0,
      "monthLimitMaxCreditSpendSoft": 0,
      "orderPaid": 0,
      "orderNotPaid": 0,
      "orderNew": 0,
      "orderProcessing": 0,
      "orderStorno": 0,
      "orderDone": 0,
      "score": 0,
      "totalRevenue": 0,
      "paidOrderCount": 0,
      "refundTotal": 0,
      "firstOrderDate": "example_firstOrderDate",
      "lastOrderDate": "example_lastOrderDate",
      "lastPaidOrderDate": "example_lastPaidOrderDate",
      "stornoOrderCount": 0,
      "voucherOrderCount": 0,
      "activeSubscriptionCount": 0,
      "badges": []
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key