Workstation Logo
search

Getting Started

  • Introduction
  • Authentication
  • Errors
  • Pagination
  • Versioning
  • Rate Limiting

Core APIs

  • Accounts
  • Workspaces
  • Tokens
  • Search

Application APIs

  • forumLounge
  • chatMessages
  • folderDocuments
  • event_notePlanning
  • peopleWorkers
  • handshakeRelationships
  • paletteStudio

Integration

  • SDKs & Libraries
  • Webhooks
  • Code Examples

© 2022 Workstation. All rights reserved.

api Workstation API

Comprehensive developer documentation for the Workstation platform

Quick Start

key

Authentication

Learn how to authenticate with the API using tokens and OAuth

code

Code Examples

Ready-to-use code examples in multiple programming languages

extension

SDKs & Libraries

Official SDKs and community libraries for popular languages

API Overview

The Workstation API is a RESTful API that allows you to integrate with all aspects of the Workstation platform. Build custom applications, automate workflows, and extend functionality with our comprehensive API.

  • RESTful Design - Standard HTTP methods and status codes
  • JSON Responses - All responses are in JSON format
  • OAuth 2.0 - Secure authentication and authorization
  • Rate Limited - Fair usage policies to ensure reliability
  • Versioned - Backward compatibility with version management

Base URL

Current Version

v1.0

Popular Endpoints

forum

Lounge API

Social features, posts, reactions, and spaces

GET /v1/yarns POST /v1/yarns
chat

Messages API

Channels, threads, and direct messaging

GET /v1/channels POST /v1/threads/:id/messages
folder

Documents API

File management, uploads, and organization

GET /v1/documents/:id POST /v1/documents
search

Search API

Full-text search across all content types

POST /v1/searches POST /v1/counts/:table