Sign inGet started
Docs
Get started

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 Chat:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/chatwork/latest/actions/get-chat" \
  --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.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Chatwork account that should run the action. MindCloud stores and refreshes the Chatwork credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Connect Chatwork API Token

You need access to the Chatwork account that MindCloud should use. If your Chatwork account belongs to an organization contract, an organization administrator may need to approve API usage before you can create a token.

  1. Request API access if your organization requires approval

    If your Chatwork account is managed under an organization contract, ask an organization administrator to open the Chatwork API application page and approve API usage for your account before continuing.

  2. Open the API Token page in Chatwork

    In Chatwork, click your user name in the upper-right corner, choose Service Integration, then select API Token from the left menu.

  3. Create or copy the API token

    Generate a new token if you do not already have one, or copy the existing token from the API Token page.

  4. Paste the token into MindCloud

    Return to MindCloud, choose the Chatwork API Token authentication method, and paste the token into the API Token field.

Chatwork actions

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

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

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS