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

NinjaOne Organization Documents API

Organization Documents

NinjaOne Organization Documents API is one of 22 APIs that NinjaOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization Documents. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 12 operations across 10 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 2.0.9-draft.

Requests are made against the base URL https://app.ninjarmm.com/v2.

12 operations 10 paths 6 schemas 1 DELETE3 GET1 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0.9-draft
Base URL
https://app.ninjarmm.com/v2
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NinjaOne Organization Documents API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearer) (oauth2). An API key is passed in the cookie as sessionKey (sessionKey). By default, every request must be authenticated.

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 3 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Organization Documents 12

Organization Documents

POST
/v2/organization/document/{clientDocumentId}/archive
Archive an organization document
archiveClientDocument 1 param → 200
POST
/v2/organization/documents/archive
Archives organization documents
archiveMultiPageClientDocuments body → 200
POST
/v2/organization/{organizationId}/template/{documentTemplateId}/document
Create organization document
createOrganizationDocument 2 params body → 200
GET
/v2/organization/documents
List all organization documents with field values
getClientDocumentsWithAttributeValues 5 params → 200
POST
/v2/organization/documents
Create organization documents
createOrganizationDocuments body → 200
PATCH
/v2/organization/documents
Update organization documents
updateOrganizationDocuments body → 200
DELETE
/v2/organization/document/{clientDocumentId}
Delete an archived organization document
deleteClientDocument 1 param → 204
GET
/v2/organization/document/{clientDocumentId}/signed-urls
Get organization document signed urls
getClientDocumentSignedUrls 1 param → 200
GET
/v2/organization/{organizationId}/documents
List organization documents with field values
getOrganizationDocuments 1 param → 200
POST
/v2/organization/document/{clientDocumentId}/restore
Restore an organization document
restoreClientDocument 1 param → 200
POST
/v2/organization/documents/restore
Restore multiple multi page organization documents
restoreMultiPageClientDocuments body → 200
POST
/v2/organization/{organizationId}/document/{clientDocumentId}
Update organization document
updateOrganizationDocument 2 params body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ClientDocumentWithAttributeValuesPublicApiDTO (8 properties), ClientDocumentWithUpdatedAttributeValuesPublicApiDTO (8 properties), ClientDocumentWithAttributeValuesBulkCreatePublicApiRequest (5 properties), ClientDocumentWithAttributeValuesBulkUpdatePublicApiRequest (4 properties). Each schema is shown below with its type and property counts.

ClientDocumentWithUpdatedAttributeValuesPublicApiDTO
object
8 properties
ClientDocumentWithAttributeValuesBulkCreatePublicApiRequest
object
5 properties
ClientDocumentAttributeWithValuePublicApiDTO
object
Updated Fields
3 properties
ClientDocumentWithAttributeValuesPublicApiRequest
object
3 properties
ClientDocumentWithAttributeValuesBulkUpdatePublicApiRequest
object
4 properties
ClientDocumentWithAttributeValuesPublicApiDTO
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-organization-documents-api-openapi.yml Raw ↑

Other APIs NinjaOne publishes across the network.

NinjaOne Asset Tags API
NinjaOne Backup API
NinjaOne Checklist Templates API
NinjaOne Custom Fields API
NinjaOne Custom Tabs API
NinjaOne devices API
NinjaOne Document Templates API
NinjaOne groups API
NinjaOne Knowledge Base Articles API
NinjaOne Location API
NinjaOne management API
NinjaOne organization API