> ## Documentation Index
> Fetch the complete documentation index at: https://botsify.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Bot Messenger Users — POST /api/v1/get-bot-users

> Retrieve all Messenger users subscribed to your Botsify bot with support for offset-based pagination using the limit and skip parameters.

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

**apikey** `string` *required*

Your bot's API key. You may alternatively supply this value in the `X-Api-Key` request header instead of the body.

**limit** `integer`

The maximum number of user records to return in a single response. Use this together with `skip` to paginate through large result sets.

**skip** `integer`

The number of user records to skip before returning results. Use this together with `limit` to implement offset-based pagination.

## Example Request

```bash theme={null}
curl --request POST \
  --url https://app.botsify.com/api/v1/get-bot-users \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: YOUR_BOT_API_KEY' \
  --data '{
    "limit": 50,
    "skip": 0
  }'
```

## 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.

```json theme={null}
{
  "users": [
    {
      "fbId": "user-123",
      "name": "Jane Doe",
      "subscribed": true,
      "created_at": "2024-01-10T08:00:00Z"
    },
    {
      "fbId": "user-124",
      "name": "John Smith",
      "subscribed": true,
      "created_at": "2024-01-11T09:15:00Z"
    }
  ],
  "total": 320,
  "limit": 50,
  "skip": 0
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.