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

Nuclino Workspaces API

Workspace management

Nuclino Workspaces API is one of 6 APIs that Nuclino publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and an engineering blog.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version v0.

Requests are made against a single base URL, https://api.nuclino.com/v0.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v0
Base URL
https://api.nuclino.com/v0
Authentication
API Key
License
Proprietary
Resource Areas
1

Authentication & Security 1

Nuclino Workspaces API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication. Pass your API key in the Authorization header.

Paths & Operations 2

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

Workspaces 2

Workspace management

GET
/workspaces
List workspaces
listWorkspaces 3 params → 200401429500
GET
/workspaces/{id}
Retrieve workspace
getWorkspace 1 param → 200401404429500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Workspace (8 properties), Field (3 properties), ErrorResponse (2 properties), ApiResponse (1 property). Each schema is shown below with its type and property counts.

WorkspaceListResponse
ErrorResponse
object
2 properties
Field
object
A custom field defined on a workspace
3 properties
ApiResponse
object
Standard API response envelope
1 property
Workspace
object
A Nuclino workspace
8 properties
WorkspaceResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclino-workspaces-api-openapi.yml Raw ↑

Other APIs Nuclino publishes across the network.

Nuclino Collections API
Nuclino Files API
Nuclino Items API
Nuclino Teams API
Nuclino Users API