---
title: "GET api/users"
method: GET
path: "/api/users"
tags: ["User"]
---

# GET api/users

`GET /api/users`

## Request

- Base URL: `https://app.followr.ai`
- URL: `https://app.followr.ai/api/users`
- Auth: HTTP bearer

Return the list of users

## Query parameters

- `include` string: additional relations to include in response, separated by semi-colon.
- `filter[name]` string: filter by name
- `filter[email]` string: filter by email
- `filter[companies.id]` string: filter by company id
- `sort` string: sort by field.
- `page[number]` integer: page number.
- `page[size]` integer: items per page (default 30).

## Response `200`

- object
  - `data` object[]
    - `id` integer
    - `name` string
    - `email` string
    - `referral_code` string
    - `language` string
    - `timezone` string
    - `notification_settings` string
    - `credits` integer
    - `pm_type` string
    - `pm_last_four` string
    - `cancel_reason` string
    - `referrer_url` string
    - `land_url` string
    - `has_password` boolean
    - `created_at` string
    - `updated_at` string
    - `banned_at` string
    - `password_changed_at` string

---

[API](https://skmtc.dev/followr/apis/followr-api-documentation.md) - [All operations](https://skmtc.dev/followr/apis/followr-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/followr/apis/followr-api-documentation/revisions/df7f1bbefd95?raw)