Skip to content

Nucleus One REST API

Everything in Nucleus One, from your own code.

Projects, documents, folders, tasks, forms, approvals and e-signatures over JSON and HTTPS. The same API runs the Nucleus One app, and its full reference is published.

Open the live referenceBuild a request
Base URL
https://client-api.nucleus.one/api/v1
Authentication
Authorization: Bearer <your API key>
Format
JSON requests and responses over HTTPS
Live reference
https://client-api.nucleus.one/api/v1/docs
OpenAPI file
https://client-api.nucleus.one/api/v1/openapi.json

01Authentication

One key, with your permissions.

Every request carries an API key you create in Nucleus One. The key acts as you, so it sees and changes exactly what you can.

Request header
Authorization: Bearer $NUCLEUS_ONE_API_KEY
  1. 01

    Sign in

    Open Nucleus One with the account the integration should act as.

  2. 02

    Open API Keys

    Go to your user profile and choose API Keys.

  3. 03

    Create a key

    Name it after the system that will use it, so you can tell keys apart later.

  4. 04

    Send it

    Pass it on every request as a Bearer token in the Authorization header.

Go to your API keys

02How it fits

Organization, project, then the work.

Everything lives in an organization. Projects hold the documents, folders, tasks and forms. List your organizations, pick a project and work inside it.

Find your way in
# 1. The organizations your key can see
curl https://client-api.nucleus.one/api/v1/organizations \
  -H "Authorization: Bearer $NUCLEUS_ONE_API_KEY"

# 2. The projects in one organization
curl https://client-api.nucleus.one/api/v1/organizations/ORG_ID/projects \
  -H "Authorization: Bearer $NUCLEUS_ONE_API_KEY"

# 3. The documents in one project
curl https://client-api.nucleus.one/api/v1/organizations/ORG_ID/projects/PROJECT_ID/documents \
  -H "Authorization: Bearer $NUCLEUS_ONE_API_KEY"

03What you can build

The whole app, open to your systems.

Documents

Upload, find and update files

Upload documents, list and update them, move them between folders, read revisions and comments, and restore from the recycle bin.
See the endpoints

Tasks

Run the work around them

Create, assign, complete and comment on tasks, and link the documents each task is about.
See the endpoints

Forms

Collect information

List form templates and their fields, share forms and take in submissions from your own site.
See the endpoints

Approvals

Keep decisions moving

List what is waiting for approval in a project, then approve, decline or deny it from your system.
See the endpoints

E-signatures

Get documents signed

Set up signature forms and their fields on a document, and read the signing session and its recipients.
See the endpoints

Search

Find anything

Search across an organization or inside one project, and save searches as templates people reuse.
See the endpoints

04Uploading a document

Files go straight to storage.

Uploads use a signed URL, so even large files go straight to storage instead of squeezing through an API call.

  1. 01

    Reserve

    GET documentUploads in the project. The response holds a signed upload URL.

  2. 02

    Upload

    Send the file to that signed URL. It goes straight into storage for the project.

  3. 03

    Confirm

    PUT documentUploads with the reservation, the file name and size, and any field values.

  4. 04

    Done

    Nucleus One processes the file and it appears in the project, ready to search.

Next

Every parameter, every response.

The live reference lists every endpoint the API offers. Generate a typed client from the OpenAPI file, or build a first request here.

Live referenceEndpoint overview