Retrieve a list of users

get

https://api.zenoti.com/v1/marketing/target_segments/{target_segment_id}/guests

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Response Model

Json property	Data type	Description
guests	List	Returned users that match the rule criteria, when successful.
error	ApiErrorModel	Error information when the request fails or is blocked.

guests object (RuleUser)

Json property	Data type	Description
id	Guid	Unique identifier of the user.
name	string	Full name of the user.
first_name	string	User’s first name.
last_name	string	User’s last name.
user_code	string	External or custom user code.
base_center	string	Home center name or identifier.
gender	string	Gender value recorded for the user.
type	string	Guest type classification or label.
spent	double	Lifetime spend attributed to the user.
email	string	Email address for the user.
mobile_phone	string	Mobile phone number.
home_phone	string	Home phone number.
address1	string	Address line one.
address2	string	Address line two.
city	string	City of the user’s address.
zipcode	string	Postal or ZIP code.
state	string	State or province.
country	string	Country name or code.
nationality	string	Nationality of the user.
dob	DateTime?	Date of birth, when available.
anniversary_date	DateTime?	Anniversary date, when applicable.
visits	int	Total number of recorded visits.
first_visit	DateTime?	Date of the first visit recorded.
last_visit	DateTime?	Date of the most recent visit.
referral_source	string	How the user was referred.
receive_marketing_email	bool	Consent flag for marketing emails.
receive_marketing_sms	bool	Consent flag for marketing SMS.
receive_marketing_whatsapp	bool	Consent flag for WhatsApp marketing.
relationship_manager	string	Assigned relationship manager’s name.
relationship_manager_id	string	Identifier of the relationship manager.
target_segment_center	string	Center used for segment evaluation context.
creation_date	DateTime?	User profile creation timestamp.

error object (ApiErrorModel)

Json property	Data type	Description
code	string	Application error code indicating the failure reason.
message	string	Human-readable description of the error encountered.

Query Params

center_id

string

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_id

string

View identifier to scope fields and presentation.

view_mode

int32

Specifies the mode in which the view is displayed.

version

string

Rules engine version for evaluation.

display_transactional_data

boolean

Include transactional data in results for UI display.

pii_export_request_id

string

Required when requires_pii_approval_flow=true for export flow.

requires_pii_approval_flow

boolean

Indicates request is for export and needs approval routing.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

Response Model

guests object (RuleUser)

error object (ApiErrorModel)

200200

400400