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 Incoming Requests API

The Incoming Requests API from Chatwork — 2 operation(s) for incoming requests.

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

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

This API exposes 3 operations across 2 paths, and defines 2 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 2 paths 2 schemas 1 DELETE1 GET1 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 Incoming Requests 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 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Incoming Requests 3
GET
/incoming_requests
List incoming contact requests
listIncomingRequests → 200
PUT
/incoming_requests/{request_id}
Approve an incoming contact request
approveIncomingRequest 1 param → 200
DELETE
/incoming_requests/{request_id}
Reject an incoming contact request
rejectIncomingRequest 1 param → 204

Schemas 2

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

Contact
object
5 properties
IncomingRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwork-incoming-requests-api-openapi.yml Raw ↑

Other APIs Chatwork publishes across the network.

Chatwork Contacts API
Chatwork Files API
Chatwork Link API
Chatwork Me API
Chatwork Members API
Chatwork Messages API
Chatwork Rooms API
Chatwork Tasks API