Segments
List segments
Retrieve a list of segments with pagination support.
get/segments
Request
- Base URLhttps://api.commonroom.io/api/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
limitinteger
The maximum number of segments to return per page
cursorstring
Pagination cursor from a previous response
colsstring
Comma-separated list of additional columns to include in the response. Valid column values: entityCount, url, summary, automationStatus. The meta column recordCount can be requested to return the total number of matching segments in meta.recordCount.
querystring
Filter segments by name (substring match)
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.