---
title: "Get a segment by ID"
method: GET
path: "/segments/{id}"
tags: ["Segments"]
---

# Get a segment by ID

`GET /segments/{id}`

## Request

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

Retrieve a specific segment by its unique identifier.

## Path parameters

- `id` string, required

## Query parameters

- `cols` string

## Response `200`

OK

- SegmentResponse
  - `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.

## Other responses

- `400`: Bad Request (e.g. invalid segment ID or invalid parameters)
- `403`: Forbidden
- `404`: Segment not found
- `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)