GET /subscribers

Scope required: (Manage Flow)

Get list of subscribers by seaching for name, phone, email, tag, custom user field and so on.

Servers

Name	Type	Required	Description
`is_bot_interacted_in_last_24h`	String	No	Search for subscribers have bot interacted within last 24 hours, available value 'yes', 'no'
`label_id`	Integer	No	Search for subscriber has label with specified label_id
`is_last_message_in_last_24h`	String	No	Search for subscribers have last message within last 24 hours, including message sent from bot user, agent and bot, available value 'yes', 'no'
`tag_ns`	String	No	Search for subscriber has tag with specified tag_ns
`is_opt_in_sms`	String	No	Search for subscriber is opted in SMS, available value 'yes', 'no'
`event_ns`	String	No	Search for subscriber has custom event with specified event_ns
`is_interacted_in_last_24h`	String	No	Search for subscriber is interacted within last 24 hours, available value 'yes', 'no'
`page`	Integer	No	Page number, between 1 and 1000
`is_opt_in_email`	String	No	Search for subscriber is opted in email, available value 'yes', 'no'
`user_field_ns`	String	No	Search for subscriber has custom user field with specified value from `user_field_value`
`limit`	Integer	No	Number of items in the response, between 1 and 100
`name`	String	No	Search for subscriber name
`email`	String	No	Search for subscriber email
`phone`	String	No	Search for subscriber phone
`is_channel`	String	No	Search for subscriber is from channel, available value 'facebook', 'instagram', 'whatsapp_cloud', 'whatsapp', 'google', 'telegram', 'tiktok', 'line', 'viber', 'vk', 'wechat', 'web', 'apichat'
`user_field_value`	String	No	specified value for custom user field `user_field_ns`

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.