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

Workflowy Nodes API

Create, read, update, move, complete, and delete outline nodes.

Workflowy Nodes API is one of 2 APIs that Workflowy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Nodes. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 9 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://workflowy.com/api/v1.

9 operations 6 paths 4 schemas 1 DELETE3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://workflowy.com/api/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Workflowy Nodes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiKey). By default, every request must be authenticated.

  • apiKey — Workflowy API key sent as a bearer token in the Authorization header. Generate a key at https://workflowy.com/api-key/.

Paths & Operations 9

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

Nodes 9

Create, read, update, move, complete, and delete outline nodes.

POST
/nodes
Create a node
createNode body → 200
GET
/nodes
List nodes
listNodes 1 param → 200404
POST
/nodes/{id}
Update a node
updateNode 1 param body → 200
GET
/nodes/{id}
Retrieve a node
getNode 1 param → 200
DELETE
/nodes/{id}
Delete a node
deleteNode 1 param → 200
POST
/nodes/{id}/move
Move a node
moveNode 1 param body → 200
POST
/nodes/{id}/complete
Complete a node
completeNode 1 param → 200
POST
/nodes/{id}/uncomplete
Uncomplete a node
uncompleteNode 1 param → 200
GET
/nodes-export
Export all nodes
exportNodes → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed is Node (9 properties). Each schema is shown below with its type and property counts.

ParentTarget
string
A parent reference - full node id, 12-character short id, node URL, a user-defined shortcut key, "None" (root), "inbox", or calendar targets ("calendar", "toda…
ExportNode
Node
object
A node is a single bullet point that can contain text, have child nodes, and be organized hierarchically.
9 properties
LayoutMode
string
Display mode of the node.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workflowy-nodes-api-openapi.yml Raw ↑

Other APIs Workflowy publishes across the network.

Workflowy Targets API