Rhombus Systems Partner Webservice API
The Partner Webservice API from Rhombus Systems — 22 operation(s) for partner webservice.
The Partner Webservice API from Rhombus Systems — 22 operation(s) for partner webservice.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rhombus-systems-partner-webservice-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
contact:
email: developer@rhombussystems.com
description: 'This API is for use by Rhombus customers and partners.
## Authentication
All requests require two headers:
- `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth.
- `x-auth-apikey` — Your Rhombus API key.
Example:
```
POST /api/camera/getMinimalCameraStateList
x-auth-scheme: api-token
x-auth-apikey: YOUR_API_KEY
Content-Type: application/json
```'
title: Rhombus Partner Webservice API
version: '1.0'
servers:
- description: Production Server
url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Partner Webservice
paths:
/api/partner/createPartnerClient:
post:
description: Create a client account
operationId: createPartnerClient
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_CreatePartnerClientWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_CreatePartnerClientWSResponse'
description: OK
summary: Create partner client
tags:
- Partner Webservice
/api/partner/customizeClient:
post:
description: Customize a client account
operationId: customizeClient
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_CustomizeClientWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_CustomizeClientWSResponse'
description: OK
summary: Customize client
tags:
- Partner Webservice
/api/partner/customizeClientDevice:
post:
description: Customize a client device
operationId: customizeClientDevice
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_CustomizeClientDeviceWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_CustomizeClientDeviceWSResponse'
description: OK
summary: Customize client device
tags:
- Partner Webservice
/api/partner/deleteClient:
post:
description: Delete a client account
operationId: deletePartnerClient
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_DeleteClientWebRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_DeleteClientWebResponse'
description: OK
summary: Delete partner client
tags:
- Partner Webservice
/api/partner/getApiTokenApplications:
post:
deprecated: true
description: Get details of all open api token requests for organization
operationId: partner_getApiTokenApplications
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Integration_GetApiTokenApplicationsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Integration_GetApiTokenApplicationsWSResponse'
description: OK
summary: Get API token applications
tags:
- Partner Webservice
/api/partner/getApiTokens:
post:
description: Get list of all api tokens for a partner
operationId: partner_getApiTokens
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Integration_GetPartnerApiTokensWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Integration_GetApiTokensWSResponse'
description: OK
summary: Get API tokens
tags:
- Partner Webservice
/api/partner/getClaimKeysForPartnerOrg:
post:
description: Get the claim keys associated with the authenticated partner organization
operationId: getClaimKeysForPartnerOrg
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/License_claimkey_GetClaimKeysForPartnerOrgWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/License_claimkey_GetClaimKeysForPartnerOrgWSResponse'
description: OK
summary: Get claim keys for partner organization
tags:
- Partner Webservice
/api/partner/getClientDevices:
post:
description: Retrieve a list of devices for a specific client.
operationId: getClientDevices
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetClientDevicesWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetClientDevicesWSResponse'
description: OK
summary: Get client devices
tags:
- Partner Webservice
/api/partner/getClientStatusMap:
post:
description: Get a map of all client accounts to device and location info
operationId: getPartnerClientsStatusMap
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetPartnerClientsStatusMapWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetPartnerClientsStatusMapWSResponse'
description: OK
summary: Get client status map
tags:
- Partner Webservice
/api/partner/getClientSummaryInfo:
post:
description: Get information about a client
operationId: getClientSummaryInfo
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetClientSummaryInfoWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetClientSummaryInfoWSResponse'
description: OK
summary: Get client summary info
tags:
- Partner Webservice
/api/partner/getClients:
post:
description: Get a list of all client accounts
operationId: getPartnerClients
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetPartnerClientsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetPartnerClientsWSResponse'
description: OK
summary: Get partner clients
tags:
- Partner Webservice
/api/partner/getClientsV2:
post:
description: 'Get a list of all client accounts. NOTICE: This is the same as getPartnerClients, but only returns the basic info so partners can login to clients quickly. The other info will be returned by getPartnerClientsStatusMap.'
operationId: getPartnerClientsV2
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetPartnerClientsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetPartnerClientsWSResponse'
description: OK
summary: Get partner clients V2
tags:
- Partner Webservice
/api/partner/getDeviceLicensesForOrg:
post:
deprecated: true
description: Get a list of licenses available for a client organization
operationId: getDeviceLicensesForOrg
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/License_GetDeviceLicensesForClientOrgWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/License_GetDeviceLicensesForClientOrgWSResponse'
description: OK
summary: Get device licenses for organization
tags:
- Partner Webservice
/api/partner/getLicensesForOrg:
post:
deprecated: true
description: Get a list of licenses available for a client organization
operationId: getLicensesForOrg
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/License_GetLicensesForClientOrgWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/License_GetLicensesForClientOrgWSResponse'
description: OK
summary: Get licenses for organization
tags:
- Partner Webservice
/api/partner/getListOfAllClientDevices:
post:
description: Retrieve list of all devices registered across all clients
operationId: getListOfAllClientDevices
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetListOfAllClientDevicesRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetListOfAllClientDevicesResponse'
description: OK
summary: Get list of all client devices
tags:
- Partner Webservice
/api/partner/getListOfAvailableHardware:
post:
description: Retrieve a list of hardware available for remote registration. Any hardware originally registered by a Partner is available for re-registration after being removed from an active client account.
operationId: getListOfControlledHardware
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetListOfControlledHardwareRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetListOfControlledHardwareResponse'
description: OK
summary: Get list of available hardware
tags:
- Partner Webservice
/api/partner/getShipments:
post:
description: Get client shipments
operationId: PartnerGetShipments
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetShipmentsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_GetShipmentsWSResponse'
description: OK
summary: Get client shipments
tags:
- Partner Webservice
/api/partner/reassignDeviceOrg:
post:
description: Reassign device(s) to a different organization. Only devices which hardware is controlled by the partner can be reassigned
operationId: reassignDeviceOrg
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_ReassignDeviceOrgWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_ReassignDeviceOrgWSResponse'
description: OK
summary: Reassign device organization
tags:
- Partner Webservice
/api/partner/registerCameraToClient:
post:
description: Register a controlled camera to a client
operationId: registerCameraToClient
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Org_CreatePendingRegistrationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Org_CreatePendingRegistrationResponse'
description: OK
summary: Register camera to client
tags:
- Partner Webservice
/api/partner/registerDeal:
post:
description: Register a deal
operationId: registerDeal
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_RegisterDealWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_RegisterDealWSResponse'
description: OK
summary: Register deal
tags:
- Partner Webservice
/api/partner/revokeApiToken:
post:
description: 'Remove an api token from organization. Note: this is irreversible'
operationId: partner_revokeApiToken
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Integration_RevokeApiTokenWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Integration_RevokeApiTokenWSResponse'
description: OK
summary: Revoke API token
tags:
- Partner Webservice
/api/partner/updateSendLicenseExpirationEmail:
post:
description: Update send license expiration email feature flag by org
operationId: updateManuallySendLicenseExpirationEmail
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: partner-api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: partner-api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_UpdateManuallySendLicenseExpirationEmailWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Partner_UpdateManuallySendLicenseExpirationEmailWSResponse'
description: OK
summary: Update send license expiration email
tags:
- Partner Webservice
components:
schemas:
LEDModeEnum:
type: string
enum:
- LED_OFF
- LED_RED_SOLID
- LED_GREEN_SOLID
- LED_ORANGE_SOLID
- LED_RED_BLINK
- LED_GREEN_BLINK
- LED_ORANGE_BLINK
- LED_NORMAL
Partner_CustomizeClientDeviceWSResponse:
type: object
description: Response object containing the applied client device customization settings.
properties:
customizations:
$ref: '#/components/schemas/Partner_ClientCustomizationsType'
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
warningMsg:
type:
- string
- 'null'
Partner_GetClientSummaryInfoWSResponse:
type: object
description: Response object containing client summary information including account owner, device status, and settings.
properties:
accountOwner:
$ref: '#/components/schemas/WrappedRhombusOrgUserType'
clientDeviceStatusMap:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/Partner_ConnectionCountType'
description: Map of device types to their connection status counts
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
licenseV2Enabled:
type:
- boolean
- 'null'
description: Whether license V2 is enabled for the client
example: true
locationCount:
type:
- integer
- 'null'
format: int32
description: Number of locations for the client
example: 3
manuallySendLicenseExpirationEmailEnabled:
type:
- boolean
- 'null'
description: Whether manual license expiration email sending is enabled
example: false
recentPolicyAlertCount:
type:
- integer
- 'null'
format: int32
description: Number of recent policy alerts
example: 5
warningMsg:
type:
- string
- 'null'
WrappedRhombusOrgUserType:
type: object
description: List of users in the organization
properties:
accessibleRhombusApps:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RhombusAppEnum'
uniqueItems: true
accountOwner:
type:
- boolean
- 'null'
bypassSaml:
type:
- boolean
- 'null'
changePasswordOnLogin:
type:
- boolean
- 'null'
createdAtMillis:
type:
- integer
- 'null'
format: int64
deleted:
type:
- boolean
- 'null'
email:
type:
- string
- 'null'
emailCaseSensitive:
type:
- string
- 'null'
emailVerified:
type:
- boolean
- 'null'
firstName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
mfaEnabled:
type:
- boolean
- 'null'
mfaTokenType:
$ref: '#/components/schemas/MfaTokenTypeEnum'
name:
type:
- string
- 'null'
orgUserCustomizationFlags:
type:
- object
- 'null'
additionalProperties:
type:
- string
- 'null'
orgUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
passwordSet:
type:
- boolean
- 'null'
restrictToAllowedLoginIps:
type:
- boolean
- 'null'
rhombusUserUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
status:
$ref: '#/components/schemas/UserStatusEnumType'
updatedAtMillis:
type:
- integer
- 'null'
format: int64
uuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
Integration_RevokeApiTokenWSResponse:
type: object
description: Response object for revoking an API token.
properties:
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
warningMsg:
type:
- string
- 'null'
Partner_CustomizeClientWSRequest:
type: object
description: Request object for customizing client settings and configurations.
properties:
clientOrgUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
customizations:
$ref: '#/components/schemas/Partner_ClientCustomizationsType'
DeviceTypeV2:
type: object
description: List of all client devices
properties:
createdAtMillis:
type:
- integer
- 'null'
format: int64
customData:
type:
- string
- 'null'
deleted:
type:
- boolean
- 'null'
description:
type:
- string
- 'null'
facetNameMap:
type:
- object
- 'null'
additionalProperties:
type:
- string
- 'null'
hardwareId:
type:
- string
- 'null'
# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-partner-webservice-api-openapi.yml