---
title: "List teams"
method: GET
path: "/teams"
tags: ["Teams"]
---

# List teams

`GET /teams`

List all the teams that the current user is a member of. `user_id=me` must be passed in the query parameters.

## Query parameters

- `user_id` string — Filter for the teams that the user is a member of. Can be either `me` or an ID. Must be `me` in the client API
- `order_by` 'created_at' — Field to order results by. Currently only `created_at` is supported.
- `desc` 'true' | 'false' — Whether to order results in descending order. Defaults to false (ascending).
- `limit` integer — The maximum number of items to return (capped at 200).
- `cursor` string — The cursor to start the result set from. Requires `limit` to also be set.
- `query` string — A search query to filter the results by. Free-text search applied to the team's id (exact-match) and display name.

## Response `200`

Successful response

- object
  - `items` object[], required
    - `id` string, required — The unique identifier of the team
    - `display_name` string, required — Human-readable team display name. This is not a unique identifier.
    - `profile_image_url` 'null', nullable — URL of the profile image for team. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.
    - `client_metadata` object, nullable — Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.
    - `client_read_only_metadata` object, nullable — Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.
  - `pagination` object
    - `next_cursor` 'null', nullable — The cursor to fetch the next page of results. null if there is no next page.

---

[API](https://skmtc.net/hexclave/apis/hexclave-rest-api.md) · [All operations](https://skmtc.net/hexclave/apis/hexclave-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hexclave/hexclave-rest-api/revisions/86dcd8c9953c/schema)