Chatwork API Documentation

This is the complete API documentation for connecting to the Chatwork API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Chatwork: Chat, manage tasks, and share files in Chatwork. Keep reading to get started.

Quickstart

Before you run your first Chatwork request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Chatwork connection — create or choose one in Connections. Note its connectionId.

Every Chatwork action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/chatwork/latest/actions/{actionSlug}

You need a MindCloud API Key and a Chatwork connection. Then call an action such as Get My Profile:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/chatwork/latest/actions/get-my-profile" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Chatwork account. See Chatwork API Authentication for the full flow and how to get your connection credentials.

Chatwork actions

All 24 published actions for this Chatwork version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Chat Task
• POSTCreate Group Chat
• DELETEDelete Chat Message
• GETGet Chat
• GETGet Chat File
• GETGet Chat Message
• GETGet Chat Task
• GETGet My Profile
• GETGet My Status
• DELETELeave or Delete Chat
• GETList Chat Files
• GETList Chat Members
• GETList Chat Messages
• GETList Chat Tasks
• GETList Chats
• GETList My Tasks
• PUTMark Message Unread
• PUTMark Messages Read
• POSTPost Chat Message
• PUTUpdate Chat
• PUTUpdate Chat Members
• PUTUpdate Chat Message
• PUTUpdate Chat Task Completion Status
• POSTUpload Chat File

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS