---
title: "User overview"
method: GET
path: "/api/users/{username}/overview"
tags: ["users"]
---

# User overview

`GET /api/users/{username}/overview`

## Path parameters

- `username` string, required

## Response `200`

User overview data including their organizations, stats, and creation date

- object
  - `_id` string, required — A hex string of 24 characters representing an ObjectId.
  - `orgs` object[]
    - `id` string, required
    - `name` string, required
    - `fullname` string, required
    - `avatarUrl` string, required
  - `avatarUrl` string, required
  - `fullname` string, required
  - `isPro` boolean, required
  - `user` string, required
  - `numModels` number
  - `numDatasets` number
  - `numSpaces` number
  - `numBuckets` number
  - `numKernels` number
  - `numDiscussions` number
  - `numPapers` number
  - `numUpvotes` number
  - `numLikes` number
  - `numFollowers` number
  - `numFollowing` number
  - `numFollowingOrgs` number
  - `details` string
  - `isFollowing` boolean
  - `reasonToFollow` string
  - `primaryOrgAvatarUrl` string
  - `serviceAccount` object — Set when the user is a service account
    - `id` string, required — A hex string of 24 characters representing an ObjectId.
    - `org` string, required
    - `orgAvatarUrl` string, required
    - `description` string
  - `type` 'user', required
  - `createdAt` string, date-time, required
  - `hardwareItems` object[] — The user's hardware items, unless the user set them as private
    - `mem` number, required — Memory in GB
    - `num` number, required — Number of units
    - `isPrimary` true

## Changes

- **2026-09-08** `bd17546f47b8` — 2 breaking, 1 info
  - the `hardwareItems/items/isPrimary` response's property type changed from no type to `boolean` for status `200`
  - the `type` response's property type changed from no type to `string` for status `200`
  - the `createdAt` response's property pattern was changed from `^((\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|(02)-(0[1-9]|1\d|2[0-8])))T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d+)?(Z)$` to `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$` for the status `200`
- **2026-08-21** `4ea565dddd8a` — 1 info
  - added the optional property `serviceAccount` to the response with the `200` status
- **2026-08-04** `493ff2971a73` — 1 info
  - added the optional property `hardwareItems` to the response with the `200` status
- **2026-07-26** `36390f25f00f` — 2 info
  - added the optional property `numBuckets` to the response with the `200` status
  - added the optional property `numKernels` to the response with the `200` status

[Change history](https://skmtc.dev/huggingface/apis/hub-api-endpoints/changes/api/users/:username/overview/get.md)

---

[API](https://skmtc.dev/huggingface/apis/hub-api-endpoints.md) · [All operations](https://skmtc.dev/huggingface/apis/hub-api-endpoints/llms.txt) · [OpenAPI document](https://skmtc.dev/huggingface/apis/hub-api-endpoints/revisions/74f2b0d17636?raw)