Skip to content

Request builder

Build a request. Copy it. Run it.

Pick a Nucleus One endpoint, fill in your IDs and copy a ready-to-run command. Your API key stays on your own machine.

Get an API keyLive reference
1. Pick an endpoint
2. Fill in your IDs

Nothing to fill in. This call only needs your key.

3. Copy and run

cURL
curl "https://client-api.nucleus.one/api/v1/organizations" \
  -H "Authorization: Bearer $NUCLEUS_ONE_API_KEY" \
  -H "Accept: application/json"
JavaScript (Node 18+)
const res = await fetch("https://client-api.nucleus.one/api/v1/organizations", {
  headers: {
    Authorization: `Bearer ${process.env.NUCLEUS_ONE_API_KEY}`,
    Accept: "application/json",
  },
});
console.log(await res.json());

Set NUCLEUS_ONE_API_KEY in your terminal or server first. This page never asks for your key.

01Your first five minutes

From a new key to real data.

Every request here is a read, so you can try them against your own account without changing anything.

  1. 01

    Create a key

    Sign in to Nucleus One, open your profile and choose API Keys. The key acts as you, with exactly your permissions.

  2. 02

    Set it on your machine

    Store it as NUCLEUS_ONE_API_KEY in your terminal or server environment. The commands this page builds read it from there, so it never goes in the code.

  3. 03

    List your organizations

    Copy the first request and run it. The response gives you each organization ID, which the next requests need.

  4. 04

    Work down the tree

    Paste the IDs in to list projects, then folders, documents, revisions, tasks and approvals inside a project.

02Questions

Before you run it.

New to the API? The API guide covers keys in more detail, and Nucleus One shows what the API sits on.

Why did I get a 401?

A 401 means the key is wrong or has been deleted. Create a new one in your profile and set it again.

Which languages work?

Any language with an HTTP client. The API speaks plain JSON over HTTPS. You can also generate a typed client from the published OpenAPI file.

Go further

Writes, uploads and the rest.

Creating tasks, uploading documents and acting on approvals are all in the API. The guide walks through them.

API guideEndpoint overview