v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve a list of users

This API retrieves a list of users that match specific rule criteria.

get/v1/marketing/target_segments/{target_segment_id}/guests

Query parameters

center_idstring

Center identifier for evaluating the rules. view_id string (UUID) No View identifier to scope fields and presentation. view_mode integer / enum (ViewMode) No UI mode or data view style for results. version string No Rules engine version for evaluation. display_transactional_data boolean No Include transactional data in results for UI display. pii_export_request_id string (UUID) Cond.* Required when requires_pii_approval_flow=true for export flow. requires_pii_approval_flow boolean No Indicates request is for export and needs approval routing.

view_idstring

View identifier to scope fields and presentation.

view_modeinteger

Specifies the mode in which the view is displayed.

versionstring

Rules engine version for evaluation.

display_transactional_databoolean

Include transactional data in results for UI display.

pii_export_request_idstring

Required when requires_pii_approval_flow=true for export flow.

requires_pii_approval_flowboolean

Indicates request is for export and needs approval routing.

Response

200

{"stackTrail":"paths:/v1/marketing/target_segments/{target_segment_id}/guests:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "guests": [
    {
      "id": "b7229528-f2d9-4cc0-b158-0dff44642af1",
      "name": " ",
      "base_center": "Khammam",
      "gender": "Male",
      "type": "Guest",
      "email": "hrushikeshk@zenoti.com",
      "country": "India",
      "receive_marketing_email": true,
      "receive_marketing_sms": true,
      "target_segment_center": "Khammam",
      "creation_date": "2015-02-04T07:06:59"
    }
  ]
}