How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Common Room Segments API

The Segments API from Common Room — 3 operation(s) for segments.

Common Room Segments API is one of 23 APIs that Common Room publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Segments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.commonroom.io/community/v1.

5 operations 3 paths 7 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.commonroom.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Common Room Segments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — Use a Core API JWT as a Bearer token in the Authentication header. Tokens can be created by room Admins through https://app.commonroom.io/ Example: curl -H "Au…

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Segments 5
GET
/segments
Get segments in a room
getSegments → 200429
POST
/segments
Create a segment
body → 201400403409429
GET
/segments/{id}/status
Gets all status for a segment
getSegmentStatuses → 200429
POST
/segments/{id}deprecated
Add Contact(s) to Segment
addContactsToSegment body → 200400404429
GET
/segments/{id}
Get a segment by ID
2 params → 200400403404429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ApiSegment (5 properties), CreateSegmentRequest (4 properties), Status (3 properties), SegmentResponse (2 properties). Each schema is shown below with its type and property counts.

ApiV2Error
object
2 properties 2 required
ApiV2ErrorResponse
object
2 properties 2 required
ApiSegment
object
5 properties 3 required
Status
object
3 properties
CreateSegmentResponse
object
2 properties 2 required
CreateSegmentRequest
object
4 properties 1 required
SegmentResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

common-room-segments-api-openapi.yml Raw ↑

Other APIs Common Room publishes across the network.

Common Room SCIM API
Common Room Activities API
Common Room Contacts API
Common Room Custom Fields API
Common Room Data Available API
Common Room Industries API
Common Room Lead Scores API
Common Room Locations API
Common Room Me API
Common Room Object Types API
Common Room Objects API
Common Room Organizations API
Where this information came from

This is an independent, third-party profile of Common Room Segments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.