> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Get minimal camera list

> Use /getMinimalCameraStateList instead

**Deprecated.** This operation is kept for existing integrations; avoid it in new code.

```http
POST https://api2.rhombussystems.com/api/camera/getMinimalList
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
- `Authorization` (header): instead of an API key, an OAuth access token (`Bearer <token>`) with the `read` scope.
- `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`.
- `x-auth-org` (header, string<RUUID>): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`.

## Request body

Content type: `application/json`. Request to retrieve a minimal list of cameras (deprecated).

- `includeMummified` (boolean | null): Whether to include mummified cameras in the response

## Response 200

OK. Content type: `application/json`

- `cameras` (array<object> | null): List of minimal camera information
- `error` (boolean | null)
- `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
- `errorMsg` (string | null)
- `warningMsg` (string | null)

## Errors

Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/camera/getMinimalList:
    post:
      deprecated: true
      description: Use /getMinimalCameraStateList instead
      operationId: getCameraMinimalList
      parameters:
        - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters."
          example: api-token
          in: header
          name: x-auth-scheme
          required: false
          schema:
            default: api-token
            enum:
              - api-token
              - api
              - api-oauth-token
              - federated-token
              - partner-api-token
              - partner-api
              - partner-api-oauth-token
            type: string
        - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`."
          in: header
          name: x-auth-org
          required: false
          schema:
            format: RUUID
            maxLength: 22
            minLength: 22
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Camera_GetMinimalListWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Camera_GetMinimalListWSResponse"
          description: OK
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      security:
        - ApiKeyAuth: []
        - oauth2:
            - read
      summary: Get minimal camera list
      tags:
        - Camera Webservice
components:
  schemas:
    Camera_GetMinimalListWSRequest:
      description: Request to retrieve a minimal list of cameras (deprecated).
      properties:
        includeMummified:
          description: Whether to include mummified cameras in the response
          example: false
          nullable: true
          type: boolean
      type: object
    Camera_GetMinimalListWSResponse:
      description: Response containing a minimal list of cameras (deprecated).
      properties:
        cameras:
          description: List of minimal camera information
          items:
            $ref: "#/components/schemas/Camera_MinimalCameraType"
          nullable: true
          type: array
        error:
          nullable: true
          type: boolean
        errorCode:
          description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
          nullable: true
          type: string
        errorMsg:
          nullable: true
          type: string
        warningMsg:
          nullable: true
          type: string
      type: object
    Camera_MinimalCameraType:
      description: Minimal camera information type.
      properties:
        connectionStatus:
          $ref: "#/components/schemas/Camera_StatusEnum"
        defaultInterface:
          description: Default network interface
          example: eth0
          nullable: true
          type: string
        defaultInterfaceMac:
          description: MAC address of default interface
          example: 00:11:22:33:44:55
          nullable: true
          type: string
        floorNumber:
          description: Floor number where the camera is located
          example: 1
          format: int32
          nullable: true
          type: integer
        healthStatus:
          $ref: "#/components/schemas/Camera_StatusEnum"
        healthStatusDetails:
          $ref: "#/components/schemas/Camera_HealthStatusDetailsEnum"
        lanAddresses:
          description: List of LAN addresses
          items:
            description: List of LAN addresses
            nullable: true
            type: string
          nullable: true
          type: array
        latitude:
          description: Latitude coordinate of the camera
          example: 37.7749
          format: double
          nullable: true
          type: number
        liveStreamShared:
          description: Whether live stream is shared
          example: false
          nullable: true
          type: boolean
        locationUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        longitude:
          description: Longitude coordinate of the camera
          example: -122.4194
          format: double
          nullable: true
          type: number
        mediaRegion:
          description: Media region
          example: us-west-1
          nullable: true
          type: string
        mummified:
          description: Whether the camera is mummified
          example: false
          nullable: true
          type: boolean
        name:
          description: Name of the camera
          example: Front Door Camera
          nullable: true
          type: string
        policyUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        region:
          description: Camera region
          example: us-west-1
          nullable: true
          type: string
        serialNumber:
          description: Camera serial number
          example: CAM123456789
          nullable: true
          type: string
        ssid:
          description: WiFi SSID
          example: MyNetwork
          nullable: true
          type: string
        uuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        wifiApMac:
          description: MAC address of WiFi access point
          example: AA:BB:CC:DD:EE:FF
          nullable: true
          type: string
        wifiBars:
          description: WiFi signal strength in bars (1-5)
          example: 4
          format: int32
          nullable: true
          type: integer
        wifiSignalStrength:
          description: WiFi signal strength in dBm
          example: -45
          format: int32
          nullable: true
          type: integer
      type: object
    Camera_StatusEnum:
      description: Status enumeration for camera states.
      enum:
        - RED
        - ORANGE
        - GREEN
      type: string
    Camera_HealthStatusDetailsEnum:
      description: Detailed health status enumeration for cameras.
      enum:
        - DISCONNECTED
        - FIRMWARE_BEHIND
        - NONE
      type: string
  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
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````
