> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
> Use this file to discover all available pages before exploring further.

# Get client summary info

> Get information about a client



## OpenAPI

````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/partner/getClientSummaryInfo
openapi: 3.0.1
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 API
  version: '1.0'
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/partner/getClientSummaryInfo:
    post:
      tags:
        - Partner Webservice
      summary: Get client summary info
      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
components:
  schemas:
    Partner_GetClientSummaryInfoWSRequest:
      type: object
      description: Request object for getting client summary information.
      properties:
        clientOrgUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
    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
          additionalProperties:
            $ref: '#/components/schemas/Partner_ConnectionCountType'
          description: Map of device types to their connection status counts
          nullable: true
        error:
          type: boolean
          nullable: true
        errorMsg:
          type: string
          nullable: true
        licenseV2Enabled:
          type: boolean
          description: Whether license V2 is enabled for the client
          example: true
          nullable: true
        locationCount:
          type: integer
          format: int32
          description: Number of locations for the client
          example: 3
          nullable: true
        manuallySendLicenseExpirationEmailEnabled:
          type: boolean
          description: Whether manual license expiration email sending is enabled
          example: false
          nullable: true
        recentPolicyAlertCount:
          type: integer
          format: int32
          description: Number of recent policy alerts
          example: 5
          nullable: true
        warningMsg:
          type: string
          nullable: true
    WrappedRhombusOrgUserType:
      type: object
      description: List of users in the organization
      properties:
        accessibleRhombusApps:
          type: array
          items:
            $ref: '#/components/schemas/RhombusAppEnum'
          nullable: true
          uniqueItems: true
        accountOwner:
          type: boolean
          nullable: true
        bypassSaml:
          type: boolean
          nullable: true
        changePasswordOnLogin:
          type: boolean
          nullable: true
        createdAtMillis:
          type: integer
          format: int64
          nullable: true
        deleted:
          type: boolean
          nullable: true
        email:
          type: string
          nullable: true
        emailCaseSensitive:
          type: string
          nullable: true
        emailVerified:
          type: boolean
          nullable: true
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        mfaEnabled:
          type: boolean
          nullable: true
        mfaTokenType:
          $ref: '#/components/schemas/MfaTokenTypeEnum'
        name:
          type: string
          nullable: true
        orgUserCustomizationFlags:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        orgUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        passwordSet:
          type: boolean
          nullable: true
        restrictToAllowedLoginIps:
          type: boolean
          nullable: true
        rhombusUserUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        status:
          $ref: '#/components/schemas/UserStatusEnumType'
        updatedAtMillis:
          type: integer
          format: int64
          nullable: true
        uuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
    Partner_ConnectionCountType:
      type: object
      description: Device connection count information for partner clients.
      properties:
        connectedCount:
          type: integer
          format: int32
          description: Number of connected devices
          example: 45
          nullable: true
        operationalCount:
          type: integer
          format: int32
          description: Number of operational devices
          example: 42
          nullable: true
        totalCount:
          type: integer
          format: int32
          description: Total number of devices
          example: 50
          nullable: true
    RhombusAppEnum:
      type: string
      enum:
        - PARTNER
        - CONSOLE
        - RHOMBUS_KEY
        - UNKNOWN
    MfaTokenTypeEnum:
      type: string
      enum:
        - EMAIL
        - SMS
        - VIRTUAL_MFA
        - FIDO
    UserStatusEnumType:
      type: string
      enum:
        - JOINED
        - PENDING
        - INACTIVE
        - UNKNOWN
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header
        set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey

````