/bff/contact-segment/options

Returns {value,label} pairs scoped to the caller organisation. value = opaque per-organisation code (orderGroup.code / product.code / productCategory.code); internal numeric IDs are never exposed. Used by the admin segment editor to populate autocomplete pickers and to render chip labels for already-selected codes.

ContactgetBffContact-segmentOptions

Parameters

4 query

Query parameters

· 4

refTypestringRequired

One of: orderGroup, product, productCategory.

Exampleexample_refType

qstringOptional

Free-text search query.

Exampleexample_q

codesstringOptional

Comma-separated list of codes to resolve to {value,label} pairs (used to render existing selections without an extra round-trip per chip).

Exampleexample_codes

limitstringOptional

Exampleexample_limit

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

valuestringRequired

labelstringRequired

Response example

application/json

{
  "items": [
    {
      "value": "example_value",
      "label": "example_label"
    }
  ]
}

Request example

GET /bff/contact-segment/options

get

curl -X GET "https://api.bizkithub.com/bff/contact-segment/options?refType=example_refType&q=example_q&codes=example_codes&limit=example_limit" \
  -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