Organization Management APIs Overview
The Organization Management APIs enable you to programmatically control your entire organizational hierarchy. These APIs help you structure and maintain your managed services environment through three key organizational levels: Service Organizations, Customers, and Sites.
Organizational Structure Overview
N-central uses a hierarchical organizational model that flows from Service Organizations down to individual devices:
Service Organization (SO)
└── Customers
└── Sites
└── Devices
Each level serves a specific purpose in organizing and managing your N-central environment.
API Methods
Service Organizations
Service Organizations are top-level units that enable multiple MSP businesses to operate independently within a single N-central instance.
Key Features
- Maintain separate customer bases for different MSP organizations.
- Control independent user and technician accounts.
- Configure organization-specific rules and notifications.
- Manage distinct feature sets for each organization.
Key Endpoints
- List Organizations (GET /api/service-orgs): Retrieve all service organizations.
- Create Organization (POST /api/service-orgs): Add a new service organization.
- Get Organization (GET /api/service-orgs/{soId}): Access specific organization details.
- List Customers (GET /api/service-orgs/{soId}/customers): View customers under an organization.
Customers
Customers represent your MSP clients and exist within Service Organizations.
Key Features
- Group and manage client devices collectively.
- Apply customer-specific monitoring policies.
- Configure customer-level settings.
- Scale efficiently as your client base grows.
Key Endpoints
- List Customers (GET /api/customers): Access all customers across organizations.
- Get Customer (GET /api/customers/{customerId}): Retrieve specific customer details.
- Create Customer (POST /api/service-orgs/{soId}/customers): Add a new customer to an organization.
- Manage Sites (GET/POST /api/customers/{customerId}/sites): Control customer locations.
Sites
Sites are optional sub-groups within Customers that enable location-based device management.
Key Features
- Organize devices by physical location.
- Integrate with PSA tools (MSP Manager, ConnectWise, Autotask).
- Provide location-specific monitoring and management.
- Configure features independently for each site.
Key Endpoints
- List Sites (GET /api/sites): View all sites across customers.
- Get Site (GET /api/sites/{siteId}): Access specific site information.
- Create Site (POST /api/customers/{customerId}/sites): Add a new location to a customer.
- Get Registration Token (GET /api/sites/{siteId}/registration-token): Enable device enrollment.
Key Features
Organization Hierarchy Management
- Three-tier organizational structure (Service Organization → Customer → Site)
- Clear parent-child relationships for device organization
- Support for custom external IDs for system integration
- Ability to map organizational units to PSA tools
Service Organization Features
- Independent management of customer bases
- Separate user and technician accounts per organization
- Organization-specific rules and notifications
- Distinct feature sets per Service Organization
Customer Management
- Flexible device grouping under customers
- Support for both single and multi-site customers
- Professional and Essential license type options
- Customer-level monitoring and management settings
Site Capabilities
- Location-based device organization
- Integration with MSP Manager, Help Desk Manager, Autotask, and ConnectWise
- Independent site-level feature configuration
- Support for satellite office management
Common Implementation Patterns
Creating a Complete Organizational Structure
# 1. Create a Service Organization
POST /api/service-orgs
{
"soName": "Acme MSP",
"contactFirstName": "John",
"contactLastName": "Doe"
}
# 2. Add a Customer
POST /api/service-orgs/{soId}/customers
{
"customerName": "TechCorp Industries",
"contactFirstName": "Sarah",
"contactLastName": "Johnson",
"licenseType": "Professional"
}
# 3. Create a Site
POST /api/customers/{customerId}/sites
{
"siteName": "Downtown Office",
"contactFirstName": "Michael",
"contactLastName": "Brown"
}
Updated 6 days ago