List Botsify Account Users — GET /api/v1/get-users - Botsify

Use this endpoint to list all users registered in your Botsify account. You authenticate using a Bearer token and can page through the full result set using the page query parameter. This is helpful when you need a complete view of everyone who has access to your account for reporting or management purposes.

Request

integer

The page number to retrieve. Omit this parameter to receive the first page of results.

Example Request

curl --request GET \
  --url 'https://app.botsify.com/api/v1/get-users?page=1' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response

A successful request returns a paginated JSON object containing an array of workspace user records. Each record includes the user’s ID, name, email address, role, and account creation timestamp. Pagination metadata is included to help you iterate through the complete user list.

{
  "data": [
    {
      "id": 1,
      "name": "Alice Johnson",
      "email": "alice@example.com",
      "role": "admin",
      "created_at": "2023-06-01T12:00:00Z"
    },
    {
      "id": 2,
      "name": "Bob Williams",
      "email": "bob@example.com",
      "role": "agent",
      "created_at": "2023-07-15T09:30:00Z"
    }
  ],
  "current_page": 1,
  "per_page": 20,
  "total": 45
}