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

Groups/folders of items

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

Tagged areas include Collections. 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 5 operations across 2 paths, and defines 8 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.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 POST1 PUT

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 Collections 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 5

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

Collections 5

Groups/folders of items

GET
/items
List items and collections
listItems 5 params → 200401429500
POST
/items
Create item or collection
createItem body → 200400401429500
GET
/items/{id}
Retrieve item or collection
getItem 1 param → 200401404429500
PUT
/items/{id}
Update item or collection
updateItem 1 param body → 200400401404429500
DELETE
/items/{id}
Delete item or collection
deleteItem 1 param → 200401404429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Item (12 properties), CreateItemRequest (6 properties), UpdateItemRequest (2 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

DeleteResponse
ItemListResponse
UpdateItemRequest
object
Request body for updating an item or collection
2 properties
ErrorResponse
object
2 properties
ApiResponse
object
Standard API response envelope
1 property
CreateItemRequest
object
Request body for creating an item or collection
6 properties
Item
object
A Nuclino item (wiki page) or collection (page group)
12 properties
ItemResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclino-collections-api-openapi.yml Raw ↑

Other APIs Nuclino publishes across the network.

Nuclino Files API
Nuclino Items API
Nuclino Teams API
Nuclino Users API
Nuclino Workspaces API