search_workspace_people

This reference is generated from the published tool contract.

Behavior and boundaries

Searches the Google Workspace directory live in enabled Google accounts. It returns an empty result for consumer accounts and never writes directory data.

Permissions

Granted scopes, accounts, calendars and visibility rules limit access. Workspace administrators do not automatically gain access to other users’ accounts.

contacts:read

Consent and boundaries

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 30
    }
  },
  "required": [
    "query",
    "limit"
  ],
  "additionalProperties": false
}

Output

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string"
          },
          "accountName": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "contact": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "displayName": {
                "type": "string"
              },
              "givenName": {
                "type": "string"
              },
              "familyName": {
                "type": "string"
              },
              "emailAddresses": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "phoneNumbers": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "organization": {
                "type": "string"
              },
              "jobTitle": {
                "type": "string"
              },
              "writable": {
                "type": "boolean"
              },
              "updatedAt": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "displayName",
              "emailAddresses",
              "phoneNumbers",
              "writable"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "accountId",
          "accountName",
          "provider",
          "contact"
        ],
        "additionalProperties": false
      }
    },
    "truncated": {
      "type": "boolean"
    },
    "ausgeschlossen": {
      "type": "object",
      "properties": {
        "andereOrganisation": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "arbeitGesperrt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "inaktivesKonto": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "providerNichtUnterstuetzt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "scopeFehlt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "tenantUnbekannt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "andereOrganisation",
        "arbeitGesperrt",
        "inaktivesKonto",
        "providerNichtUnterstuetzt",
        "scopeFehlt",
        "tenantUnbekannt"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "contacts",
    "truncated",
    "ausgeschlossen"
  ],
  "additionalProperties": false
}

Errors and retries

Check the tool result for errors. Do not blindly retry writes after a timeout. Check the calendar state first.

Error handling