cigchat_search_subscribers
Search subscribers by name, phone, email, tag, or custom field to locate and manage specific audience members.
Instructions
Get list of subscribers by seaching for name, phone, email, tag, custom user field and so on. [GET /subscribers] Requires the "Manage Flow" scope on the token.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Search for subscriber name | |
| page | No | Page number, between 1 and 1000 | |
| No | Search for subscriber email | ||
| limit | No | Number of items in the response, between 1 and 100 | |
| phone | No | Search for subscriber phone | |
| tag_ns | No | Search for subscriber has tag with specified tag_ns Accepts either the tag namespace id or the tag's exact name — the server resolves names automatically. | |
| event_ns | No | Search for subscriber has custom event with specified event_ns Accepts either the custom_event namespace id or the custom_event's exact name — the server resolves names automatically. | |
| label_id | No | Search for subscriber has label with specified label_id | |
| is_channel | No | Search for subscriber is from channel, available value 'facebook', 'instagram', 'whatsapp_cloud', 'whatsapp', 'google', 'telegram', 'tiktok', 'line', 'viber', 'vk', 'wechat', 'web', 'apichat' | |
| segment_ns | No | Search for subscriber matched with segment with specified segment_ns Accepts either the segment namespace id or the segment's exact name — the server resolves names automatically. | |
| is_opt_in_sms | No | Search for subscriber is opted in SMS, available value 'yes', 'no' | |
| user_field_ns | No | Search for subscriber has custom user field with specified value from `user_field_value` | |
| is_opt_in_email | No | Search for subscriber is opted in email, available value 'yes', 'no' | |
| user_field_value | No | specified value for custom user field `user_field_ns` | |
| is_interacted_in_last_24h | No | Search for subscriber is interacted within last 24 hours, available value 'yes', 'no' | |
| is_last_message_in_last_24h | No | Search for subscribers have last message within last 24 hours, including message sent from bot user, agent and bot, available value 'yes', 'no' | |
| is_bot_interacted_in_last_24h | No | Search for subscribers have bot interacted within last 24 hours, available value 'yes', 'no' |