Skip to content

Nucleus One API reference

The endpoints you will use most.

Grouped by what they do. Every path starts with https://client-api.nucleus.one/api/v1. The live reference has every parameter, request body and response.

Organizations and projects

  • GET/organizationsList the organizations you belong to
  • GET/organizations/{organizationId}Get an organization
  • GET/organizations/{organizationId}/projectsList the projects in an organization
  • POST/organizations/{organizationId}/projectsCreate projects
  • GET/organizations/{organizationId}/projects/{projectId}Get a project
  • PUT/organizations/{organizationId}/projects/{projectId}Update a project

Documents

Paths below follow /organizations/{organizationId}/projects/{projectId}

  • GET/documentsList the documents in a project
  • GET/documentUploadsReserve an upload and get a signed URL
  • PUT/documentUploadsConfirm uploaded documents
  • PUT/documents/{documentId}Update a document
  • GET/documents/{documentId}/revisionsList a document’s revisions
  • GET/documents/{documentId}/commentsList a document’s comments
  • POST/documentActions/setDocumentFolderMove documents to a folder
  • POST/documentActions/sendToRecycleBinSend documents to the recycle bin

Folders

Paths below follow /organizations/{organizationId}/projects/{projectId}

  • GET/documentFoldersList document folders
  • POST/documentFoldersCreate document folders
  • PUT/documentFolders/{documentFolderId}Update a folder

Tasks

Paths below follow /organizations/{organizationId}/projects/{projectId}

  • GET/tasksList tasks
  • POST/tasksCreate tasks
  • GET/tasks/{taskId}Get a task
  • POST/tasks/{taskId}/actions/assignAssign a task
  • POST/tasks/{taskId}/actions/completeComplete a task
  • POST/tasks/{taskId}/commentsComment on a task
  • POST/tasks/{taskId}/documentsLink documents to a task

Forms

Paths below follow /organizations/{organizationId}/projects/{projectId}

  • GET/formTemplatesList form templates
  • GET/formTemplates/{formTemplateId}/fieldsList a form’s fields
  • POST/formTemplateActions/shareShare a form

Approvals

Paths below follow /organizations/{organizationId}/projects/{projectId}

  • GET/approvalsList pending approvals
  • POST/approvals/actions/approveApprove
  • POST/approvals/actions/declineDecline
  • POST/approvals/actions/denyDeny

E-signatures

Paths below follow /organizations/{organizationId}/projects/{projectId}

  • GET/documents/{documentId}/signatureFormsList a document’s signature forms
  • POST/documents/{documentId}/signatureForms/{documentSignatureFormId}/fieldsAdd signature fields
  • GET/documents/{documentId}/signatureSessionPackagesGet the signing session
  • GET/signatureFormTemplatesList signature form templates

API keys

  • GET/user/apiKeysList your API keys
  • POST/user/apiKeysCreate API keys
  • DELETE/user/apiKeysDelete API keys

Try it

Build a request and run it.

Pick an endpoint, fill in your IDs and copy a ready-to-run command for your terminal.