Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chatwork Rooms API

The Rooms API from Chatwork — 2 operation(s) for rooms.

Chatwork Rooms API is one of 9 APIs that Chatwork publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://api.chatwork.com/v2.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://api.chatwork.com/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Chatwork Rooms API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-ChatWorkToken (chatworkToken). By default, every request must be authenticated.

  • chatworkToken — API token issued from your Chatwork account settings.

Paths & Operations 5

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

Rooms 5
GET
/rooms
List rooms you belong to
listRooms → 200
POST
/rooms
Create a new group chat room
createRoom body → 200
GET
/rooms/{room_id}
Retrieve a room
getRoom 1 param → 200
PUT
/rooms/{room_id}
Update a room
updateRoom 1 param body → 200
DELETE
/rooms/{room_id}
Leave or delete a room
deleteRoom 2 params → 204

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Room (13 properties), RoomCreate (9 properties), RoomUpdate (3 properties). Each schema is shown below with its type and property counts.

RoomUpdate
object
3 properties
Room
object
13 properties
RoomCreate
object
9 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwork-rooms-api-openapi.yml Raw ↑

Other APIs Chatwork publishes across the network.

Chatwork Contacts API
Chatwork Files API
Chatwork Incoming Requests API
Chatwork Link API
Chatwork Me API
Chatwork Members API
Chatwork Messages API
Chatwork Tasks API