Sign in
Clients

Get a client

One client's full settings, including its resolved config, its configId (the concurrency token every write takes), and impact — what a config edit would follow. The path segment accepts a client name or ID. A client that exists but belongs to a different project reads as 404 NOT_FOUND.

get/projects/{projectId}/clients/{client}

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

clientstring required

Client name or ID. A name is matched case-insensitively and must be unique in the project; an ambiguous name is refused with 409 CONFLICT listing the candidate ids rather than resolved to one of them.

Query parameters

includePrivateBackingboolean

Include clients that exist only as the private backing of a User Testing scenario. Excluded by default, matching the Clients tab; this is an administrative opt-in and applies to name resolution as well as to listing.

Response

The client settings.

idstring required
namestring required
configIdstring

The concurrency token — see Client.configId.

configobject required

Client config v2 DTO. Opaque object; shape mirrors the inspector's client editor.

ownerScopeobject nullable required
hasComputerboolean
createdAtnumber

Unix epoch milliseconds.

updatedAtnumber

Unix epoch milliseconds.

Changes