Skip to main content
POST
Search client environments

Authorizations

Authorization
string
header
required

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.

Body

application/json
userIDs
string[]
required

User IDs to fetch client environments for (format tus-<number>).

type
enum<string>

Client environment type.

Available options:
web,
app
limit
integer
default:100

Maximum number of client environments to return. Defaults to 100, maximum 10000.

Required range: 1 <= x <= 10000

Response

Matching client environments.

id
string
required

Client environment container ID (format tce-<number>).

handle
string
required

Client environment handle.

osName
enum<string>
required

Operating system name.

Available options:
Windows,
macOS,
Linux,
iOS,
iPadOS,
Android,
ChromeOS,
Other
clientEnvType
enum<string>
required

Client environment type.

Available options:
web,
app
createdMs
integer<int64>
required

Creation time in milliseconds since epoch.

dataWeb
object[]
dataApp
object[]