BizKitHub
DocsAPI ReferenceContact/bff/contact-segment/contacts
getContactAdmin BFF

/bff/contact-segment/contacts

Real-time list — the segment definition is translated to SQL on every request, so any edit is reflected immediately without precomputed membership.

ContactgetBffContact-segmentContacts

Parameters

5 query

Query parameters

· 5
idstringRequired

Segment external ID.

Exampleexample_id
pagestringOptional
Exampleexample_page
limitstringOptional
Exampleexample_limit
filterFulltextQuerystringOptional
Exampleexample_filterFulltextQuery
orderBystringOptional
Exampleexample_orderBy

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

GET /bff/contact-segment/contacts

get
curl -X GET "https://api.bizkithub.com/bff/contact-segment/contacts?id=example_id&page=example_page&limit=example_limit&filterFulltextQuery=example_filterFulltextQuery&orderBy=example_orderBy" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key