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

# List tags

`GET /tags`

## Request

- Base URL: `https://api.commonroom.io/api/v2`
- URL: `https://api.commonroom.io/api/v2/tags`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/tags/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of tags (user-defined and auto-generated) for the community, with pagination support.

## Query parameters

- `limit` integer
- `cursor` string
- `query` string
- `entityType` 'contact' | 'organization' | 'activity' | 'object'

## Response `200`

OK

- TagList
  - `success` true, required
  - `data` ApiTag[], required
    - `id` string, required: Prefixed tag ID (format `l_<number>`)
    - `name` string, required: The tag's display name
    - `description` string, nullable: Human-readable description of the tag
    - `entityTypes` string[]: Entity types this tag can be applied to
    - `objectTypeId` string: For object tags, the object type (format `cot_<number>`) whose records the tag applies to
  - `meta` object, required
    - `nextCursor` string, nullable, required: Cursor for pagination; pass as the `cursor` query parameter to fetch the next page.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `429`: Rate Limited

---

[API](https://skmtc.dev/commonroom/apis/common-room-api-v2.md) - [All operations](https://skmtc.dev/commonroom/apis/common-room-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/commonroom/apis/common-room-api-v2/revisions/865d4d43dadf?raw)