GET/v1/workspace/directory

List the connected directory's people

Everyone in the Google Workspace or Microsoft 365 domain this workspace has a verified delegation for, each placed against the roster: seated (already has a seat here, with their account id and seat), invited (an open invite already names their address) or new. Each row also says whether the provider has suspended the account. Reach for it to answer 'who at the company still has no access' or 'has anyone who left still got a seat'. Needs a connected delegation; admin and Enterprise.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

bodyquery · nulloptional

paramsquery · objectoptional

queryquery · objectoptional

providerstringoptional

Responses

200application/json

the action's answer

{
  "data": {
    "domain": "string",
    "people": [
      {
        "accountId": "",
        "address": "string",
        "displayName": "string",
        "role": "string",
        "state": "string",
        "suspended": "string"
      }
    ],
    "provider": "string",
    "provisioning": {
      "autoInvite": true,
      "defaultRole": "string",
      "lastSyncedAt": "string",
      "provider": "string"
    }
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired