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 Me API

The Me API from Chatwork — 3 operation(s) for me.

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

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

This API exposes 3 operations across 3 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.

3 operations 3 paths 3 schemas 3 GET

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 Me 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 3

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

Me 3
GET
/me
Retrieve your account information
getMe → 200
GET
/my/status
Retrieve your unread, mentions, and task counts
getMyStatus → 200
GET
/my/tasks
Retrieve your tasks across all rooms
getMyTasks 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Me (9 properties), Task (8 properties), MyStatus (6 properties). Each schema is shown below with its type and property counts.

MyStatus
object
6 properties
Task
object
8 properties
Me
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwork-me-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 Members API
Chatwork Messages API
Chatwork Rooms API
Chatwork Tasks API