Remotehost Docs
API ReferenceOrg workspaces

List an External workspace's end users with their usage and caps

GET
/orgs/{orgId}/workspaces/{workspaceId}/end-users

Needs billing.read. Every end user with usage in the workspace's projects this billing period, an override, or a notice, by machine-hours descending, with the cap that holds it and whether it reached it. An API key may call it; a key pinned to a workspace only for its own, and any other workspace answers it the same 404 as one that does not exist. An Internal workspace has no end users: every operation here answers it with 409 internal_workspace. Off until the workspace API is enabled for this deployment: until then it answers 404 to everyone.

Authorization

bearerAuth
AuthorizationBearer <token>

A RemoteHost API key (rh_sk_...) or a user session token.

In: header

Path Parameters

orgId*string
workspaceId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/orgs/string/workspaces/string/end-users"
{  "workspace": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "kind": "internal"  },  "defaultMachineHourLimit": 0,  "action": "refuse_new",  "periodStartsAt": "string",  "periodEndsAt": "string",  "endUsers": [    {      "endUserId": "string",      "machineHours": 0,      "estimatedCogsUsd": 0,      "machineHourLimit": 0,      "limitSource": "override",      "status": "under",      "reachedAt": "string"    }  ]}