Common Room

Common Room Contacts API

The Contacts API from Common Room — 6 operation(s) for contacts.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /source/{destinationSourceId}/user Add or update a user in an API signal source · Add or Edit User #
Ask an LLM
“How do I add a person from my own system into Common Room as a contact?”
“Can I update a user I already sent by reusing the same ID?”
Tell an agent
Add user {id} to source {destinationSourceId}.
Add user {id} named {fullName} with email {email} to source {destinationSourceId}.
GET /members/customFields List contact custom fields for a room · Gets all contact custom fields for a room #
Ask an LLM
“What custom fields are defined on contacts in our room?”
“Can I see the contact custom fields tied to one destination source?”
Tell an agent
List all contact custom fields in our room.
List the contact custom fields for source {destinationSourceId}.
GET /user/{email} Look up a contact's profile by email · Get Contact by E-Mail #
Ask an LLM
“How do I find a contact's full profile when all I have is their email address?”
“Can I retrieve someone's Common Room profile from a single email?”
Tell an agent
Get the contact profile for email {email}.
Pull up the person whose email address is {email}.
DELETE /user/{email} Request anonymization of a contact by email · Anonymize Contact #
Ask an LLM
“How do I remove a contact's personal data when they ask to be forgotten?”
“Does anonymizing a contact happen immediately or is it queued?”
Tell an agent destructive · confirm first
Anonymize the contact with email {email}.
Queue removal of all personal information for {email}.
GET /members Find a contact by email or social handle · Get Contact By E-Mail or Socials #
Ask an LLM
“Can I find a contact by their GitHub, Twitter or LinkedIn handle?”
“Which lookup works when I have a social handle instead of a contact ID?”
Tell an agent
Find the contact with GitHub handle {github}.
Look up the member whose Twitter handle is {twitter} or LinkedIn is {linkedin}.
GET /contacts/{id} Get a contact by its ID · Get a contact by ID #
Ask an LLM
“How do I fetch one contact when I have its c_ ID?”
“Can I include columns like primary email or location when retrieving a contact by ID?”
Tell an agent
Get contact {id}.
Fetch contact {id} with columns {cols}.
GET /contacts List contacts with filters and paging · List contacts #
Ask an LLM
“What's the way to page through every contact in our community?”
“Can I list only the contacts in a given segment or organization?”
Tell an agent
List the contacts in segment {segmentId}.
List contacts at organization {organizationId} sorted by {sort}.

Documentation

📖
Documentation
https://api.commonroom.io/docs/community.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/common-room/refs/heads/main/openapi/common-room-contacts-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/common-room/refs/heads/main/overlays/common-room-contacts-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/common-room:common-room-contacts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

common-room-contacts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Common Room Contacts API
  x-logo:
    url: /common-room-api-logo.svg
  version: '1.0'
  description: 'Operations tagged Contacts across 2 of this provider''s published API definitions: common-room-core-openapi.yml, common-room-v2-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.commonroom.io/community/v1
  description: Common Room Core API v1
- url: https://api.commonroom.io/community/v2
  description: Common Room API v2
tags:


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/common-room/refs/heads/main/openapi/common-room-contacts-api-openapi.yml