Organizations
/lmp/api/v1/organizations
List organizations
Returns a paginated list of organizations belonging to the authenticated parent organization.
Required permission
Permission | Description |
|---|---|
| View organizations and their storage and current usage. |
organizations:read
Description
View organizations and their storage and current usage.
Parameters
Parameter | Type | Description |
|---|---|---|
|
| — |
|
| Page number. |
|
| Page size (max 300). Default is 100. |
|
| Sort field. Prefix with - for descending. |
root
Type
objectDescription
—
p
Type
numberDescription
Page number.
l
Type
numberDescription
Page size (max 300). Default is 100.
s
Type
"createdAt" | "-createdAt"Description
Sort field. Prefix with - for descending.
Responses
Status | Description |
|---|---|
| Paginated list of organizations. |
| Missing or invalid API key. |
| API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint. |
200
Description
Paginated list of organizations.
401
Description
Missing or invalid API key.
403
Description
API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint.
/lmp/api/v1/organizations
Create organization
Creates a new organization under the authenticated parent organization. Requires a name (unique within the partner) and an optional notes field (max 200 characters).
Required permission
Permission | Description |
|---|---|
| Create and delete client organizations. |
organizations:write
Description
Create and delete client organizations.
Request body
Field | Type | Description |
|---|---|---|
|
| Required. |
|
| — |
name
Type
objectDescription
Required.
notes
Type
stringDescription
—
Responses
Status | Description |
|---|---|
| Organization created. |
| Validation error or business constraint violated. |
| Missing or invalid API key. |
| API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint. |
201
Description
Organization created.
400
Description
Validation error or business constraint violated.
401
Description
Missing or invalid API key.
403
Description
API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint.
/lmp/api/v1/organizations/{organizationId}
Get organization
Returns a single organization.
Required permission
Permission | Description |
|---|---|
| View organizations and their storage and current usage. |
organizations:read
Description
View organizations and their storage and current usage.
Parameters
Parameter | Type | Description |
|---|---|---|
|
| Required. Organization ID. |
organizationId
Type
stringDescription
Required. Organization ID.
Responses
Status | Description |
|---|---|
| Organization. |
| Missing or invalid API key. |
| API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint. |
| Organization not found or does not belong to the authenticated parent organization. |
200
Description
Organization.
401
Description
Missing or invalid API key.
403
Description
API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint.
404
Description
Organization not found or does not belong to the authenticated parent organization.
/lmp/api/v1/organizations/{organizationId}
Delete organization
Deletes an organization belonging to the authenticated parent organization. All workspaces and filespaces under the organization are permanently removed. A client in status new, trial or trial_expired can be deleted. Any other status blocks deletion, except that an MSP-family client without workspaces can still be deleted.
Required permission
Permission | Description |
|---|---|
| Create and delete client organizations. |
organizations:write
Description
Create and delete client organizations.
Responses
Status | Description |
|---|---|
| Organization deleted. |
| Deletion constraint violated. |
| Missing or invalid API key. |
| API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint. |
| Organization not found or does not belong to this parent organization. |
204
Description
Organization deleted.
400
Description
Deletion constraint violated.
401
Description
Missing or invalid API key.
403
Description
API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint.
404
Description
Organization not found or does not belong to this parent organization.
/lmp/api/v1/organizations/{organizationId}/usage/current
Get organization current usage
Returns the organization's usage for the current billing period. Available for VAR client organizations, and for your own organization when it is an MSP-family reseller. Includes member counts, per-provider storage usage (GB), and optional LucidLink Connect and TeamCache metrics when included in the contract.
Required permission
Permission | Description |
|---|---|
| View organizations and their storage and current usage. |
organizations:read
Description
View organizations and their storage and current usage.
Parameters
Parameter | Type | Description |
|---|---|---|
|
| Required. Organization ID. |
organizationId
Type
stringDescription
Required. Organization ID.
Responses
Status | Description |
|---|---|
| Current billing period usage. |
| Not available for this organization (MSP client organizations have no contract of their own). |
| Missing or invalid API key. |
| API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint. |
| Organization not found, does not belong to this partner, or has no active contract. |
200
Description
Current billing period usage.
400
Description
Not available for this organization (MSP client organizations have no contract of their own).
401
Description
Missing or invalid API key.
403
Description
API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint.
404
Description
Organization not found, does not belong to this partner, or has no active contract.
/lmp/api/v1/organizations/{organizationId}/usage
Get organization storage usage
Returns paginated storage usage records for an organization. Each record captures per-filespace storage measurements (object store and S3) at a given moment. Filter by storage type (aws, custom, wasabi, ibm) and date range (ISO 8601 datetimes). Data is retained for 2 months; a date range entirely outside that window returns a BadRequest(400).
Required permission
Permission | Description |
|---|---|
| View organizations and their storage and current usage. |
organizations:read
Description
View organizations and their storage and current usage.
Parameters
Parameter | Type | Description |
|---|---|---|
|
| — |
|
| Required. Organization ID. |
|
| Storage type to filter by. When omitted, usage of all storage types is returned. |
|
| Required. Start of the date range (ISO 8601 with timezone offset, e.g. 2026-04-21T15:22:00.000Z). |
|
| Required. End of the date range (ISO 8601 with timezone offset, e.g. 2026-05-21T15:22:00.000Z). |
|
| Page number. |
|
| Page size (max 300). Default is 100. |
|
| Sort field. Prefix with - for descending. |
root
Type
objectDescription
—
organizationId
Type
stringDescription
Required. Organization ID.
type
Type
"aws" | "custom" | "wasabi" | "ibm"Description
Storage type to filter by. When omitted, usage of all storage types is returned.
start
Type
stringDescription
Required. Start of the date range (ISO 8601 with timezone offset, e.g. 2026-04-21T15:22:00.000Z).
end
Type
stringDescription
Required. End of the date range (ISO 8601 with timezone offset, e.g. 2026-05-21T15:22:00.000Z).
p
Type
numberDescription
Page number.
l
Type
numberDescription
Page size (max 300). Default is 100.
s
Type
"createdAt" | "-createdAt"Description
Sort field. Prefix with - for descending.
Responses
Status | Description |
|---|---|
| Paginated storage usage records. |
| Date range or storage type invalid. |
| Missing or invalid API key. |
| API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint. |
| Organization not found or does not belong to this parent organization. |
200
Description
Paginated storage usage records.
400
Description
Date range or storage type invalid.
401
Description
Missing or invalid API key.
403
Description
API key is valid but the request is not allowed: the organization is not a channel partner, the request IP is not in the key's allow-list, or the key lacks the permission required by this endpoint.
404
Description
Organization not found or does not belong to this parent organization.