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

# Search client environments

> Finds observed client environments for selected Observe users.

Required API key permission: `observe:clientEnvs:read`.



## OpenAPI

````yaml /api-reference/openapi/observe.yaml post /observe/clientEnvSearch
openapi: 3.1.1
info:
  version: 1.0.0
  title: Corbado API
  description: >
    # Introduction

    This documentation gives an overview of all Corbado API calls to implement
    authentication observe.
  contact:
    name: Corbado team
    email: support@corbado.com
    url: https://www.corbado.com
servers:
  - url: https://api.cloud.corbado.io/v1
security:
  - bearerAuth: []
tags:
  - name: ObserveFlow
    description: Flow search and related APIs
    x-group: Journeys and users
  - name: ObserveSubFlow
    description: Subflow search and related APIs
    x-group: Journeys and users
  - name: ObserveUser
    description: User search and related APIs
    x-group: Journeys and users
  - name: ObserveClientEnv
    description: Client environment search APIs
    x-group: Journeys and users
  - name: ObserveTimeSeries
    description: Time series query APIs
    x-group: Metrics and funnels
  - name: ObserveFunnel
    description: Historical funnel metrics, dictionaries and coverage.
    x-group: Metrics and funnels
  - name: ObserveEvent
    description: Event ingestion and event feed APIs
    x-group: Events
  - name: ObserveError
    description: Named authentication errors and recommendations.
    x-group: Error management
  - name: ObserveErrorFlavour
    description: Error variants and their impact on authentication outcomes.
    x-group: Error management
  - name: ObserveAlert
    description: Authentication alert rules, instances and history.
    x-group: Alert management
  - name: ObserveAnnotation
    description: Annotation APIs (dated notes for analytics context)
    x-group: Annotations
  - name: ObserveTableExport
    description: Table export file listing and download APIs
    x-group: Data exports
  - name: ObserveTimeSeriesExport
    description: Time-series export generation and downloads.
    x-group: Data exports
  - name: ObserveDataExport
    description: Data export APIs
    x-group: User data
  - name: ObserveDataDeletionJob
    description: Data deletion job APIs
    x-group: User data
  - name: ObserveFlowTypeDefinition
    description: Flow type definitions used in authentication journeys.
    x-group: Catalogs and labels
  - name: ObserveCatalog
    description: Catalog APIs
    x-group: Catalogs and labels
  - name: OpenAPI
    description: Downloadable API specification
  - name: ProjectOperationExecution
    description: Project-scoped operation history and pipeline health
  - name: ObserveClassification
    description: Flow and subflow classification APIs
  - name: ObserveIntegrationStats
    description: Integration stats APIs
  - name: ObserveTimeSeriesPrecalculation
    description: Time series precalculation APIs
  - name: ObserveIDList
    x-group: Saved ID lists
    description: Stored ID-list selection APIs
  - name: ObserveDataContext
    description: Schema-loose data context APIs for agent and debugging tooling
  - name: ObserveData
    description: Observe data administration APIs
  - name: ObserveTrackingStats
    description: Tracking ingestion stats APIs
  - name: ObserveExperiment
    x-group: Experiments
    description: Experiment catalog and run APIs
  - name: ObserveDataPolicy
    description: >-
      Project data policy catalogue (retention selected by the SDK's
      meta.dataPolicy code)
  - name: ObserveMetadata
    x-group: Metadata
    description: Authenticator metadata APIs (FIDO MDS + passkey AAGUID)
  - name: ObservePasskey
    x-group: Passkey analysis
    description: Observed passkey search and cohort analysis.
paths:
  /observe/clientEnvSearch:
    post:
      tags:
        - ObserveClientEnv
      summary: Search client environments
      description: |-
        Finds observed client environments for selected Observe users.

        Required API key permission: `observe:clientEnvs:read`.
      operationId: ObserveClientEnvSearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/observeClientEnvSearchReq'
      responses:
        '200':
          description: Matching client environments.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/observeClientEnv'
        default:
          $ref: '#/components/responses/error'
      security:
        - bearerAuth:
            - observe:clientEnvs:read
components:
  schemas:
    observeClientEnvSearchReq:
      type: object
      required:
        - userIDs
      properties:
        userIDs:
          type: array
          description: User IDs to fetch client environments for (format `tus-<number>`).
          items:
            type: string
          x-oapi-codegen-extra-tags:
            validate: required,min=1,max=500,dive,id=tus
        type:
          $ref: '#/components/schemas/observeClientEnvType'
        limit:
          type: integer
          description: >-
            Maximum number of client environments to return. Defaults to 100,
            maximum 10000.
          default: 100
          minimum: 1
          maximum: 10000
          x-oapi-codegen-extra-tags:
            validate: omitempty,min=1,max=10000
    observeClientEnv:
      type: object
      required:
        - id
        - handle
        - osName
        - clientEnvType
        - createdMs
      properties:
        id:
          type: string
          description: Client environment container ID (format `tce-<number>`).
        handle:
          type: string
          description: Client environment handle.
        osName:
          $ref: '#/components/schemas/observeClientEnvOsName'
        clientEnvType:
          $ref: '#/components/schemas/observeClientEnvType'
        createdMs:
          type: integer
          format: int64
          description: Creation time in milliseconds since epoch.
        dataWeb:
          type: array
          items:
            $ref: '#/components/schemas/observeClientEnvDataWeb'
        dataApp:
          type: array
          items:
            $ref: '#/components/schemas/observeClientEnvDataApp'
    observeClientEnvType:
      type: string
      description: Client environment type.
      enum:
        - web
        - app
    observeClientEnvOsName:
      type: string
      description: Operating system name.
      enum:
        - Windows
        - macOS
        - Linux
        - iOS
        - iPadOS
        - Android
        - ChromeOS
        - Other
    observeClientEnvDataWeb:
      type: object
      required:
        - id
        - createdMs
      properties:
        id:
          type: string
        osVersion:
          type: string
        browserName:
          type: string
        browserVersion:
          type: string
        privateMode:
          type: boolean
        webdriver:
          type: boolean
        bluetoothAvailable:
          type: boolean
        conditionalMediationAvailable:
          type: boolean
        userVerifyingPlatformAuthenticatorAvailable:
          type: boolean
        conditionalGet:
          type: boolean
        conditionalCreate:
          type: boolean
        hybridTransport:
          type: boolean
        passkeyPlatformAuthenticator:
          type: boolean
        relatedOrigins:
          type: boolean
        signalAllAcceptedCredentials:
          type: boolean
        signalCurrentUserDetails:
          type: boolean
        signalUnknownCredential:
          type: boolean
        userVerifyingPlatformAuthenticator:
          type: boolean
        extensionAppid:
          type: boolean
        extensionAppidExclude:
          type: boolean
        extensionCredBlob:
          type: boolean
        extensionCredProps:
          type: boolean
        extensionCredentialProtectionPolicy:
          type: boolean
        extensionEnforceCredentialProtectionPolicy:
          type: boolean
        extensionGetCredBlob:
          type: boolean
        extensionHmacCreateSecret:
          type: boolean
        extensionLargeBlob:
          type: boolean
        extensionMinPinLength:
          type: boolean
        extensionPayment:
          type: boolean
        extensionPrf:
          type: boolean
        maxTouchPoints:
          type: integer
          description: >-
            navigator.maxTouchPoints as reported by the client. 0 on devices
            without a touchscreen. Absent on older data and when the client did
            not report it.
        createdMs:
          type: integer
          format: int64
          description: Creation time in milliseconds since epoch.
    observeClientEnvDataApp:
      type: object
      required:
        - id
        - createdMs
      properties:
        id:
          type: string
        osVersion:
          type: string
        model:
          type: string
          description: Device model (e.g. "iPhone15,3", "Pixel 8").
        brand:
          type: string
          description: Device manufacturer/brand (e.g. "Apple", "Google").
        appName:
          type: string
          description: Host application name (e.g. "Acme Banking").
        appVersion:
          type: string
          description: Host application version (e.g. "3.2.1").
        deviceOwnerAuth:
          type: string
          enum:
            - none
            - code
            - bio-face
            - bio-touch
            - bio-strong
            - bio-weak
            - bio
          description: Device owner authentication / screen-lock method.
        isBluetoothAvailable:
          type: boolean
          description: Whether Bluetooth is available on the device.
        androidGooglePlayServicesVersion:
          type: string
          description: Google Play Services version (Android only; null on iOS).
        locale:
          type: string
          description: Device locale (BCP-47, e.g. "en-US").
        screen:
          $ref: '#/components/schemas/observeAppScreen'
        createdMs:
          description: Creation time in milliseconds since epoch
          type: integer
          format: int64
    errorRspV2:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              description: Error message
              type: string
              example: Validation failed
            details:
              description: Validation error details per field
              type: array
              items:
                type: object
                required:
                  - field
                  - message
                properties:
                  field:
                    description: Field name that failed validation
                    type: string
                    example: projectID
                  message:
                    description: Validation error message
                    type: string
                    example: required
    observeAppScreen:
      type: object
      description: >-
        Native app screen geometry in logical points plus the backing scale
        factor.
      properties:
        widthPoints:
          type: number
          format: float
        heightPoints:
          type: number
          format: float
        scale:
          type: number
          format: float
  responses:
    error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorRspV2'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an Observe API key from the management console. The key selects the
        project and must grant the permission listed on the operation. Keep this
        key on your server.

````