---
title: "List a team’s people"
method: GET
path: "/api/v1/teams/{teamId}/people"
tags: ["Teams"]
---

# List a team’s people

`GET /api/v1/teams/{teamId}/people`

## Request

- Base URL: `https://charm.ing`
- URL: `https://charm.ing/api/v1/teams/{teamId}/people`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Secure-better-auth.session_token`

User-gated (`chrm_user_*` or session); the caller must be an owner/admin of the team. Every CURRENT team member with role, apps owned, apps created, last activity, and external shares granted.

## Path parameters

- `teamId` string, required

## Query parameters

- `limit` integer
- `q` string
- `sort` 'label:asc' | 'label:desc' | 'role:asc' | 'role:desc' | 'appsOwned:asc' | 'appsOwned:desc' | 'appsCreated:asc' | 'appsCreated:desc' | 'lastActive:asc' | 'lastActive:desc' | 'externalShares:asc' | 'externalShares:desc'
- `format` 'csv'

## Response `200`

The team’s people, as JSON or (with `format=csv`) as `text/csv`.

- TeamPeopleResponse
  - `ok` true, required
  - `people` TeamPerson[], required
    - `userId` string, required
    - `label` string, required
    - `badges` NameBadges, required: The marks Charming shows beside a person’s name, derived from live plans at read time.
      - `pro` boolean, required: True while the person pays for a plan on their own account.
      - `affiliation` object, nullable, required: The paid team the person shows beside their name, or null for none.
        - `name` string, required
        - `logoUrl` string, uri, required
    - `role` string, required
    - `appsOwned` integer, required
    - `appsCreated` integer, required
    - `lastActiveMs` integer, nullable, required: Null (never epoch zero) for a member with no attributable events.
    - `externalShareCount` integer, required
  - `hasMore` boolean, required: True when the team has more members than this page returned.

## Other responses

- `400`: Invalid `limit` or `sort`.
- `401`: Sign-in required.
- `403`: The caller is not an owner/admin of this team.

---

[API](https://skmtc.dev/charm/apis/charming-api.md) · [All operations](https://skmtc.dev/charm/apis/charming-api/llms.txt) · [OpenAPI document](https://skmtc.dev/charm/apis/charming-api/revisions/a9d06c419b3a?raw)