DocsAPI ReferenceContact/bff/contact-segment/count
getContactAdmin BFF

/bff/contact-segment/count

Returns just the COUNT(*) of contacts currently matching the segment definition, excluding banned and soft-deleted contacts. No row data, no badges. Cheap enough to call from a banner / preview UI.

ContactgetBffContact-segmentCount

Parameters

1 query

1 total
Query · 1
idstringRequired

Segment external ID.

Request

GET /bff/contact-segment/count

get
curl -X GET "https://api.bizkithub.com/bff/contact-segment/count?id=example_id" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "count": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key