Segments

Get a segment by ID

Retrieve a specific segment by its unique identifier.

get/segments/{id}

Request

Base URL
https://api.commonroom.io/api/v2
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.

Path parameters

idstring required

The prefixed segment ID (format s_<number>)

Query parameters

colsstring

Comma-separated list of additional columns to include in the response. Valid values: entityCount, url, summary, automationStatus.

Response

OK

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.