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

/bff/contact-segment/contacts-export

Returns every contact that currently matches the segment definition (up to a hard cap of 10000 rows), without pagination — meant to feed a client-side CSV/JSON download.

ContactgetBffContact-segmentContacts-export

Parameters

2 query

Query parameters

· 2
idstringRequired

Segment external ID.

Exampleexample_id
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-export

get
curl -X GET "https://api.bizkithub.com/bff/contact-segment/contacts-export?id=example_id&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