Information
- License: MIT
- OpenAPI version:
3.1.0
Overview
Read and write into a The Desk workspace from an external system.
The Desk REST API 1.0.0
Section titled “The Desk REST API 1.0.0”The Desk exposes a small, URI-versioned REST API so external systems can read
and post into a workspace. It is part of the integrations platform and shares
its INTEGRATIONS_ENABLED master switch: with the platform off, every route
below returns 404.
Requests authenticate with a bearer token minted from Team settings → Integrations, which is either a bot token (acting as a non-human workspace member, limited to the channels it belongs to) or a personal access token (acting as the human who created it, with their own memberships and permissions). Tokens are displayed once at creation and stored only as a hash.
Every operation requires exactly one resource:action scope, granted to the
token when it is minted. A token missing the scope an operation requires is
answered with 403.
Authentication
Section titled “Authentication”bearerAuth
Section titled “bearerAuth”A bot token or personal access token minted from Team settings →
Integrations, sent as Authorization: Bearer <token>.
OpenAPI 3.1 requires the security requirement array to be empty for a
scheme that is not oauth2 or openIdConnect, so the one scope each
operation demands is carried in its x-required-scope extension (and
repeated at the top of its description).
Security scheme type: http