List users

List users (staff only).

Endpoint

GET /api/v1/users
Staff

Request

Supports filters (username, email, team_slug, etc.) plus page/per_page.

Usage

curl \
  --header "Authorization: Bearer $PEARING_API_TOKEN" \
  "$PEARING_API_URL/v1/users?page=1&per_page=50"

Success

200 OK with paginated users. Returned user records may include email because this endpoint is staff-only.

{
  "results": [
    {
      "uuid": "...",
      "username": "alice",
      "email": "<private>"
    }
  ],
  "next": null,
  "previous": null
}

Errors

  • 404 Not Found when team_slug filter references a missing team.

Common auth errors are documented on the API overview page.