Skip to main content
Use this endpoint to retrieve a list of all Messenger users who have interacted with or subscribed to your Botsify bot. You can paginate through the full user list using the limit and skip parameters, which lets you efficiently process large subscriber bases in batches. Your bot API key is required and can be provided in the request body or via the X-Api-Key header.

​
Request

​
string
required
Your bot’s API key. You may alternatively supply this value in the X-Api-Key request header instead of the body.
​
integer
The maximum number of user records to return in a single response. Use this together with skip to paginate through large result sets.
​
integer
The number of user records to skip before returning results. Use this together with limit to implement offset-based pagination.

​
Example Request

​
Response

A successful request returns a JSON object containing an array of Messenger user records. Each record includes the user’s identifier, name, profile details, and subscription status. The response also includes a count of the total number of users available to support pagination logic on your end.