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

# Get platform users

> Get all users belonging to your white label platform

This endpoint returns a list of all users that belong to your white label platform. Use this to display user lists and manage your platform users.

<Note>
  This endpoint is only available for **white label admins**. Regular users will receive a 403 Forbidden error.
</Note>

### Response

<ResponseField name="data" type="array">
  Array of user objects

  <Expandable title="user properties">
    <ResponseField name="id" type="integer">
      The unique identifier of the user
    </ResponseField>

    <ResponseField name="name" type="string">
      The user's full name
    </ResponseField>

    <ResponseField name="email" type="string">
      The user's email address
    </ResponseField>

    <ResponseField name="minutes_balance" type="number">
      The user's current call minutes balance
    </ResponseField>

    <ResponseField name="credits_balance" type="number">
      The user's current chat credits balance
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the user was created
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 Response theme={null}
  {
    "data": [
      {
        "id": 123,
        "name": "John Doe",
        "email": "john@example.com",
        "minutes_balance": 150.5,
        "credits_balance": 500,
        "created_at": "2025-01-05T10:30:00.000000Z"
      },
      {
        "id": 124,
        "name": "Jane Smith",
        "email": "jane@example.com",
        "minutes_balance": 75.25,
        "credits_balance": 250,
        "created_at": "2025-01-06T14:20:00.000000Z"
      }
    ]
  }
  ```

  ```json 200 Empty Response theme={null}
  {
    "data": []
  }
  ```

  ```json 403 Not White Label Admin theme={null}
  {
    "error": "You are not a white label admin."
  }
  ```
</ResponseExample>

### Use Cases

* **Display user list** in your custom white label management dashboard
* **Lookup user IDs** for use with the [transfer balance](/api-reference/white-label/transfer-balance) endpoint
* **Monitor user balances** to identify users who need credits
