Clients

GET

/lmp/api/v1/clients

List clients

Returns a paginated list of client organizations belonging to the authenticated partner.

Parameters

Parameter	Type	Description
`root`	`object`	—
`p`	`number`	Page number.
`l`	`number`	Page size (max 300). Default is 100.
`s`	`"createdAt" \| "-createdAt"`	Sort field. Prefix with - for descending.

root

Type: object
Description: —

p

Type: number
Description: Page number.

l

Type: number
Description: Page size (max 300). Default is 100.

s

Type: "createdAt" | "-createdAt"
Description: Sort field. Prefix with - for descending.

Responses

Status	Description
`200`	Paginated list of clients.
`401`	Missing or invalid API key.
`403`	API key is valid but the organization is not allowed to access the API.

200

Description: Paginated list of clients.

401

Description: Missing or invalid API key.

403

Description: API key is valid but the organization is not allowed to access the API.

POST

/lmp/api/v1/clients

Create client

Creates a new client organization under the authenticated partner organization. Requires a name (unique within the partner) and an optional notes field (max 200 characters).

Request body

Field	Type	Description
`name`	`object`	Required.
`notes`	`string`	—

name

Type: object
Description: Required.

notes

Type: string
Description: —

Responses

Status	Description
`201`	Client created.
`400`	Validation error or business constraint violated.
`401`	Missing or invalid API key.
`403`	API key is valid but the organization is not allowed to access the API.

201

Description: Client created.

400

Description: Validation error or business constraint violated.

401

Description: Missing or invalid API key.

403

Description: API key is valid but the organization is not allowed to access the API.

GET

/lmp/api/v1/clients/{clientId}

Get client

Returns a single client organization belonging to the authenticated partner.

Parameters

Parameter	Type	Description
`clientId`	`string`	Required. Client organization ID.

clientId

Type: string
Description: Required. Client organization ID.

Responses

Status	Description
`200`	Client organization.
`401`	Missing or invalid API key.
`403`	API key is valid but the organization is not allowed to access the API.
`404`	Client organization not found or does not belong to the authenticated partner.

200

Description: Client organization.

401

Description: Missing or invalid API key.

403

Description: API key is valid but the organization is not allowed to access the API.

404

Description: Client organization not found or does not belong to the authenticated partner.

DELETE

/lmp/api/v1/clients/{clientId}

Delete client

Deletes a client organization belonging to the authenticated partner. All workspaces and filespaces under the client are permanently removed. The client must be in a deletable state (no active contract or no workspaces).

Parameters

Parameter	Type	Description
`clientId`	`string`	Required.

clientId

Type: string
Description: Required.

Responses

Status	Description
`204`	Client deleted.
`400`	Deletion constraint violated.
`401`	Missing or invalid API key.
`403`	API key is valid but the organization is not allowed to access the API.
`404`	Client organization not found or does not belong to this partner.

204

Description: Client deleted.

400

Description: Deletion constraint violated.

401

Description: Missing or invalid API key.

403

Description: API key is valid but the organization is not allowed to access the API.

404

Description: Client organization not found or does not belong to this partner.

GET

/lmp/api/v1/clients/{clientId}/usage/current

Get client current usage

Returns the client organization's usage for the current billing period. Available for VAR clients only. Includes member counts, per-provider storage usage (GB), and optional LucidLink Connect and TeamCache metrics when included in the contract.

Parameters

Parameter	Type	Description
`clientId`	`string`	Required. Client organization ID.

clientId

Type: string
Description: Required. Client organization ID.

Responses

Status	Description
`200`	Current billing period usage.
`401`	Missing or invalid API key.
`403`	API key is valid but the organization is not allowed to access the API.
`404`	Client organization not found, does not belong to this partner, or has no active contract.

200

Description: Current billing period usage.

401

Description: Missing or invalid API key.

403

Description: API key is valid but the organization is not allowed to access the API.

404

Description: Client organization not found, does not belong to this partner, or has no active contract.

GET

/lmp/api/v1/clients/{clientId}/usage

Get client storage usage

Returns paginated storage usage records for a client 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).

Parameters

Parameter	Type	Description
`clientId`	`string`	Required. Client organization ID.
`root`	`object`	—
`type`	`"aws" \| "custom" \| "wasabi" \| "ibm"`	Storage type to filter by. When omitted, usage of all storage types is returned.
`start`	`string`	Required. Start of the date range (ISO 8601 with timezone offset, e.g. 2026-04-21T15:22:00.000Z).
`end`	`string`	Required. End of the date range (ISO 8601 with timezone offset, e.g. 2026-05-21T15:22:00.000Z).
`p`	`number`	Page number.
`l`	`number`	Page size (max 300). Default is 100.
`s`	`"createdAt" \| "-createdAt"`	Sort field. Prefix with - for descending.

clientId

Type: string
Description: Required. Client organization ID.

root

Type: object
Description: —

type

Type: "aws" | "custom" | "wasabi" | "ibm"
Description: Storage type to filter by. When omitted, usage of all storage types is returned.

start

Type: string
Description: Required. Start of the date range (ISO 8601 with timezone offset, e.g. 2026-04-21T15:22:00.000Z).

end

Type: string
Description: Required. End of the date range (ISO 8601 with timezone offset, e.g. 2026-05-21T15:22:00.000Z).

p

Type: number
Description: Page number.

l

Type: number
Description: Page size (max 300). Default is 100.

s

Type: "createdAt" | "-createdAt"
Description: Sort field. Prefix with - for descending.

Responses

Status	Description
`200`	Paginated storage usage records.
`400`	Date range or storage type invalid.
`401`	Missing or invalid API key.
`403`	API key is valid but the organization is not allowed to access the API.
`404`	Client organization not found or does not belong to this partner.

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 organization is not allowed to access the API.

404

Description: Client organization not found or does not belong to this partner.