How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Rhombus Systems

Rhombus Systems Partner Webservice API

The Partner Webservice API from Rhombus Systems — 22 operation(s) for partner webservice.

Documentation Provider Profile APIs.io OpenAPI GitHub

Rhombus Systems Partner Webservice API is one of 65 APIs that Rhombus Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Partner Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 22 operations across 22 paths, and defines 104 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api2.rhombussystems.com.

22 operations 22 paths 104 schemas 22 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api2.rhombussystems.com/api
Authentication
API Key
Contact
developer@rhombussystems.com
Resource Areas
1

Authentication & Security 1

Rhombus Systems Partner Webservice API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-auth-apikey (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Paths & Operations 22

Across 22 paths, the API surfaces 22 operations — 22 POST. Each is listed below with its method, path, parameters, and response codes.

Partner Webservice 22
POST
/api/partner/createPartnerClient
Create partner client
createPartnerClient 1 param body → 200
POST
/api/partner/customizeClient
Customize client
customizeClient 1 param body → 200
POST
/api/partner/customizeClientDevice
Customize client device
customizeClientDevice 1 param body → 200
POST
/api/partner/deleteClient
Delete partner client
deletePartnerClient 1 param body → 200
POST
/api/partner/getApiTokenApplicationsdeprecated
Get API token applications
partner_getApiTokenApplications 1 param body → 200
POST
/api/partner/getApiTokens
Get API tokens
partner_getApiTokens 1 param body → 200
POST
/api/partner/getClaimKeysForPartnerOrg
Get claim keys for partner organization
getClaimKeysForPartnerOrg 1 param body → 200
POST
/api/partner/getClientDevices
Get client devices
getClientDevices 1 param body → 200
POST
/api/partner/getClientStatusMap
Get client status map
getPartnerClientsStatusMap 1 param body → 200
POST
/api/partner/getClientSummaryInfo
Get client summary info
getClientSummaryInfo 1 param body → 200
POST
/api/partner/getClients
Get partner clients
getPartnerClients 1 param body → 200
POST
/api/partner/getClientsV2
Get partner clients V2
getPartnerClientsV2 1 param body → 200
POST
/api/partner/getDeviceLicensesForOrgdeprecated
Get device licenses for organization
getDeviceLicensesForOrg 1 param body → 200
POST
/api/partner/getLicensesForOrgdeprecated
Get licenses for organization
getLicensesForOrg 1 param body → 200
POST
/api/partner/getListOfAllClientDevices
Get list of all client devices
getListOfAllClientDevices 1 param body → 200
POST
/api/partner/getListOfAvailableHardware
Get list of available hardware
getListOfControlledHardware 1 param body → 200
POST
/api/partner/getShipments
Get client shipments
PartnerGetShipments 1 param body → 200
POST
/api/partner/reassignDeviceOrg
Reassign device organization
reassignDeviceOrg 1 param body → 200
POST
/api/partner/registerCameraToClient
Register camera to client
registerCameraToClient 1 param body → 200
POST
/api/partner/registerDeal
Register deal
registerDeal 1 param body → 200
POST
/api/partner/revokeApiToken
Revoke API token
partner_revokeApiToken 1 param body → 200
POST
/api/partner/updateSendLicenseExpirationEmail
Update send license expiration email
updateManuallySendLicenseExpirationEmail 1 param body → 200

Schemas 104

The contract defines 104 schemas that model the data the API accepts and returns. The most detailed are Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig (113 properties), CustomerShipmentType (27 properties), WrappedRhombusOrgUserType (22 properties), LicenseUsageType (21 properties). Each schema is shown below with its type and property counts.

LEDModeEnum
string
Partner_CustomizeClientDeviceWSResponse
object
Response object containing the applied client device customization settings.
4 properties
Partner_GetClientSummaryInfoWSResponse
object
Response object containing client summary information including account owner, device status, and settings.
9 properties
WrappedRhombusOrgUserType
object
List of users in the organization
22 properties
Integration_RevokeApiTokenWSResponse
object
Response object for revoking an API token.
3 properties
Partner_CustomizeClientWSRequest
object
Request object for customizing client settings and configurations.
2 properties
DeviceTypeV2
object
List of all client devices
16 properties
Integration_GetPartnerApiTokensWSRequest
object
LicenseEnum
string
Partner_DeviceWithPartnerDetailsType
object
Device information with partner-specific details including control and reassignment status.
3 properties
ApiClientTypeEnum
string
Partner_GetClientDevicesWSResponse
object
Response object containing devices for a specific client organization.
1 property
MfaTokenTypeEnum
string
RegionConfigType
objectnull
2 properties
Partner_GetShipmentsWSRequest
object
Request object for getting client shipments within a time range.
3 properties
CameraMountingDirectionEnum
string
Partner_GetPartnerClientsWSResponse
object
Response object containing list of partner clients.
4 properties
CustomerShipmentStateEnum
string
Partner_CustomizeClientDeviceWSRequest
object
Request object for customizing client device settings and configurations.
4 properties
License_claimkey_GetClaimKeysForPartnerOrgWSRequest
object
Request object for getting the claim keys belonging to the authenticated partner organization.
ActivityEnum
string
StatusTypeEnum
string
CameraMotorConfigType
object
8 properties
CustomerShipmentEmailStateEnum
string
Partner_PartnerWebResponseStatusEnum
string
Status responses for partner web operations.
LicenseStateEnum
string
Partner_GetPartnerClientsWSRequest
object
Request object for getting all partner clients.
RegionOfInterestGroup
object
3 properties
Integration_GetApiTokenApplicationsWSResponse
object
4 properties
Partner_GetClientDevicesWSRequest
object
Request object for getting devices for a specific client organization.
1 property
Partner_GetClientSummaryInfoWSRequest
object
Request object for getting client summary information.
1 property
LicenseFeature
object
2 properties
License_GetDeviceLicensesForClientOrgWSResponse
object
Response object containing list of device licenses available for a client organization.
1 property
AspectRatio
object
2 properties
License_claimkey_GetClaimKeysForPartnerOrgWSResponse
object
Response object containing the claim keys belonging to the authenticated partner organization.
4 properties
RhombusAppEnum
string
WeeklyMinuteIntervalType
object
2 properties
DewarpedView
object
5 properties
DeviceLicenseType
object
List of device licenses available for the client organization
18 properties
License_GetLicensesForClientOrgWSRequest
object
Request object for getting list of licenses available for a client organization.
1 property
DeviceTypeEnum
string
ProductTypeEnum
string
Partner_ClientDeviceCustomizationsType
object
Client device-specific customization settings for partner management.
2 properties
Partner_ClientCustomizationsType
object
Client-specific customization settings for partner management.
2 properties
Partner_GetListOfControlledHardwareRequest
object
Request object for getting list of controlled hardware.
PerceptionTypeEnum
string
Partner_DeleteClientWebRequest
object
Request object for deleting a partner client account.
1 property
CameraMeteringConfigType
object
2 properties
Integration_RevokeApiTokenWSRequest
object
Request object for revoking an API token.
1 property
DeviceLicenseFamilyEnum
string
CameraInactivitySettingsType
object
3 properties
Partner_CreatePartnerClientWSResponse
object
Response object containing the result of creating a partner client account.
5 properties
UploadTargetEnum
string
Partner_ReassignDeviceOrgWSResponse
object
Response object containing the status of device reassignment operations.
1 property
CameraHumanLoiteringSettingsType
object
1 property
Partner_UpdateManuallySendLicenseExpirationEmailWSResponse
object
Response object for updating manual license expiration email settings.
3 properties
Org_CreatePendingRegistrationRequest
object
Request object for creating pending hardware registration.
5 properties
CameraPTZConfigType
object
4 properties
LicenseToUnassignEmailStateEnum
string
LicenseUsageType
object
List of licenses available for the client organization
21 properties
CameraDewarpModeEnum
string
ShippedItemType
objectnull
3 properties
FisheyeDisplayModeEnum
string
Partner_GetListOfAllClientDevicesRequest
object
Request object for getting list of all client devices.
Partner_UnregisteredControlledHardwareType
object
Information about unregistered controlled hardware available for partner registration.
4 properties
Partner_PartnerClientWebType
object
Partner client information including organization details and device counts.
14 properties
HardwareVariationEnum
string
RegionCoordinateType
object
2 properties
Partner_UpdateManuallySendLicenseExpirationEmailWSRequest
object
Request object for updating manual license expiration email settings for an organization.
2 properties
Org_CreatePendingRegistrationResponse
object
Response object for creating pending hardware registration.
3 properties
Partner_CreatePartnerClientWSRequest
object
Request object for creating a new partner client account.
4 properties
Device_config_settings_ExternalVideoResolution
object
2 properties
Partner_GetListOfAllClientDevicesResponse
object
Response object containing list of all client devices.
1 property
ApiTokenAuthTypeEnum
string
Authentication type for the API token
PermyriadRect
object
5 properties
Partner_GetPartnerClientsStatusMapWSRequest
object
Request object for getting partner clients status map.
ApiTokenType
object
List of API tokens
14 properties
Integration_GetApiTokensWSResponse
object
Response object containing API tokens.
4 properties
ApiTokenApplicationType
object
9 properties
InactivityObjectTypeEnum
string
AddOnLicenseEnum
string
Partner_CustomizeClientWSResponse
object
Response object containing the applied client customization settings.
4 properties
CustomerShipmentType
object
List of customer shipments
27 properties
Partner_ReassignDeviceOrgWSRequest
object
Request object for reassigning devices from one organization to another.
3 properties 2 required
Partner_ConnectionCountType
object
Device connection count information for partner clients.
3 properties
Partner_DeleteClientWebResponse
object
Response object for deleting a partner client account.
SalesforceLicenseStartDateTimeAndEndDateTime
objectnull
2 properties
Partner_GetShipmentsWSResponse
object
Response object containing client shipments within the specified time range.
4 properties
CustomerShipmentCategoryEnum
string
Partner_RegisterDealWSResponse
object
Response object containing the result of registering a deal.
4 properties
License_GetLicensesForClientOrgWSResponse
object
Response object containing list of licenses available for a client organization.
1 property
Partner_GetPartnerClientsStatusMapWSResponse
object
Response object containing partner clients status map with device connection counts.
4 properties
OperationStatus
object
Map of device serial numbers to their reassignment operation status
2 properties
Integration_GetApiTokenApplicationsWSRequest
object
UserStatusEnumType
string
RegionOfInterest
object
Regions of interest that belong to the group. Group must have at least one region specified.
4 properties
PartnerOrgClaimKey
object
List of claim keys belonging to the partner organization
8 properties
Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig
object
Audio/video user configuration update
113 properties
Partner_RegisterDealWSRequest
object
Request object for registering a deal with partner details.
1 property
FrontendEqualizerSettings
object
3 properties
Partner_GetListOfControlledHardwareResponse
object
Response object containing list of controlled hardware.
1 property
RegionOfInterestGroupTypeEnum
string
Represents type of activity regions in the group. Defaults to 'Activity'.
RegionPolygonType
object
1 property
License_GetDeviceLicensesForClientOrgWSRequest
object
Request object for getting list of device licenses available for a client organization.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-partner-webservice-api-openapi.yml Raw ↑

Other APIs Rhombus Systems publishes across the network.

Rhombus Console WebSocket API
AE Profile APIs.io
Rhombus Systems Access Control Integrations Webservice API
AE Profile APIs.io
Rhombus Systems Access Control Webservice API
AE Profile APIs.io
Rhombus Systems Alarm Monitoring Keypad Webservice API
AE Profile APIs.io
Rhombus Systems Alert Monitoring Webservice API
AE Profile APIs.io
Rhombus Systems AudioGateway Webservice API
AE Profile APIs.io
Rhombus Systems AudioPlayback Webservice API
AE Profile APIs.io
Rhombus Systems Badge Reader Webservice API
AE Profile APIs.io
Rhombus Systems BLE Webservice API
AE Profile APIs.io
Rhombus Systems Button Webservice API
AE Profile APIs.io
Rhombus Systems Camera Webservice API
AE Profile APIs.io
Rhombus Systems ClaimKey Webservice API
AE Profile APIs.io
#Partner Webservice
← Back to R APIs
API Details
ID
rhombus-systems:rhombus-systems-partner-webservice-api
Base URL
https://api2.rhombussystems.com/api
Docs
https://api-docs.rhombus.community/
Provider
Rhombus Systems
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=rhombus-systems-partner-webservice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/rhombus-systems-partner-webservice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Rhombus Systems Partner Webservice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.