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

The Contacts API from Chatwork — 1 operation(s) for contacts.

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

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

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.

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

1 operations 1 paths 1 schemas 1 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 Contacts 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 1

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

Contacts 1
GET
/contacts
List your contacts
listContacts → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Contact (5 properties). Each schema is shown below with its type and property counts.

Contact
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwork-contacts-api-openapi.yml Raw ↑

Other APIs Chatwork publishes across the network.

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