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

# List segments

`GET /segments`

## Request

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

Retrieve a list of segments with pagination support.

## Query parameters

- `limit` integer
- `cursor` string
- `cols` string
- `query` string

## Response `200`

OK

- SegmentList
  - `success` true, required
  - `data` ApiSegment[], required
    - `id` string, required: Prefixed segment ID (format `s_<number>`)
    - `name` string, required: The segment's display name
    - `entityType` 'contact' | 'object' | 'organization', required: The type of entity this segment contains
    - `entityCount` integer: Number of entities in this segment
    - `url` string, uri: Common Room URL for this segment
    - `summary` string, nullable: AI-generated summary of the segment. Null if no summary has been generated yet.
    - `automationStatus` 'paused' | 'running', nullable: Whether the segment's rule-based membership updates are paused or running. Null for manually curated segments.
  - `meta` object, required
    - `nextCursor` string, nullable: Cursor for pagination; pass as the `cursor` query parameter to fetch the next page.
    - `recordCount` integer: Total number of records matching the query. Only returned when `cols=recordCount` is requested.

## 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)