Skip to main content
Glama

people.people.listDirectoryPeople

List domain profiles and domain contacts in the authenticated user's directory, with pagination and incremental sync support for retrieving changes since a previous request.

Instructions

Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the sync_token is specified, resources deleted since the last sync will be returned as a person with PersonMetadata.deleted set to true. When the page_token or sync_token is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the directory people that have changed](/people/v1/directory#list_the_directo [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, getBatchGet, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
sourcesNo
pageSizeNo[query parameter] Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
readMaskNo[query parameter] Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are:
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.
pageTokenNo[query parameter] Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters
syncTokenNo[query parameter] Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syn
mergeSourcesNo
requestSyncTokenNo[query parameter] Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `s

Output Schema

NameRequiredDescriptionDefault
peopleNo
nextPageTokenNo
nextSyncTokenNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • changedInput schema / properties / mergeSources / items / description
      Previous value: -"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers."New value: +"[query parameter] Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. Values: `DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED` = Unspecified.; `DIRECTORY_MERGE_SOURCE_TYPE_CONTACT` = User owned contact.."
    • changedInput schema / properties / pageSize / description
      Previous value: -"Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0."New value: +"[query parameter] Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0."
    • addedInput schema / properties / pageSize / format
      Added value: +"int32"
    • changedInput schema / properties / pageToken / description
      Previous value: -"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters"New value: +"[query parameter] Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters"
    • changedInput schema / properties / readMask / description
      Previous value: -"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: "New value: +"[query parameter] Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: "
    • addedInput schema / properties / readMask / format
      Added value: +"google-fieldmask"
    • changedInput schema / properties / requestSyncToken / description
      Previous value: -"Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `s"New value: +"[query parameter] Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `s"
    • changedInput schema / properties / sources / items / description
      Previous value: -"Required. Directory sources to return."New value: +"[query parameter] Required. Directory sources to return. Values: `DIRECTORY_SOURCE_TYPE_UNSPECIFIED` = Unspecified.; `DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT` = Google Workspace domain shared contact.; `DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE` = Google Workspace domain profile.."
    • changedInput schema / properties / syncToken / description
      Previous value: -"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syn"New value: +"[query parameter] Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syn"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "nextPageToken": {
      +      "type": "string"
      +    },
      +    "nextSyncToken": {
      +      "type": "string"
      +    },
      +    "people": {
      +      "items": {
      +        "properties": {
      +          "addresses": {
      +            "items": {
      +              "properties": {
      +                "city": {
      +                  "type": "string"
      +                },
      +                "country": {
      +                  "type": "string"
      +                },
      +                "countryCode": {
      +                  "type": "string"
      +                },
      +                "extendedAddress": {
      +                  "type": "string"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "formattedValue": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "poBox": {
      +                  "type": "string"
      +                },
      +                "postalCode": {
      +                  "type": "string"
      +                },
      +                "region": {
      +                  "type": "string"
      +                },
      +                "streetAddress": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "ageRange": {
      +            "enum": [
      +              "AGE_RANGE_UNSPECIFIED",
      +              "LESS_THAN_EIGHTEEN",
      +              "EIGHTEEN_TO_TWENTY",
      +              "TWENTY_ONE_OR_OLDER"
      +            ],
      +            "type": "string"
      +          },
      +          "ageRanges": {
      +            "items": {
      +              "properties": {
      +                "ageRange": {
      +                  "enum": [
      +                    "AGE_RANGE_UNSPECIFIED",
      +                    "LESS_THAN_EIGHTEEN",
      +                    "EIGHTEEN_TO_TWENTY",
      +                    "TWENTY_ONE_OR_OLDER"
      +                  ],
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "biographies": {
      +            "items": {
      +              "properties": {
      +                "contentType": {
      +                  "enum": [
      +                    "CONTENT_TYPE_UNSPECIFIED",
      +                    "TEXT_PLAIN",
      +                    "TEXT_HTML"
      +                  ],
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "birthdays": {
      +            "items": {
      +              "properties": {
      +                "date": {
      +                  "properties": {
      +                    "day": {
      +                      "type": "integer"
      +                    },
      +                    "month": {
      +                      "type": "integer"
      +                    },
      +                    "year": {
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "text": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "braggingRights": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "calendarUrls": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "url": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "clientData": {
      +            "items": {
      +              "properties": {
      +                "key": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "coverPhotos": {
      +            "items": {
      +              "properties": {
      +                "default": {
      +                  "type": "boolean"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "url": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "emailAddresses": {
      +            "items": {
      +              "properties": {
      +                "displayName": {
      +                  "type": "string"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "etag": {
      +            "type": "string"
      +          },
      +          "events": {
      +            "items": {
      +              "properties": {
      +                "date": {
      +                  "properties": {
      +                    "day": {
      +                      "type": "integer"
      +                    },
      +                    "month": {
      +                      "type": "integer"
      +                    },
      +                    "year": {
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "externalIds": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "fileAses": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "genders": {
      +            "items": {
      +              "properties": {
      +                "addressMeAs": {
      +                  "type": "string"
      +                },
      +                "formattedValue": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "imClients": {
      +            "items": {
      +              "properties": {
      +                "formattedProtocol": {
      +                  "type": "string"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "protocol": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "username": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "interests": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "locales": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "locations": {
      +            "items": {
      +              "properties": {
      +                "buildingId": {
      +                  "type": "string"
      +                },
      +                "current": {
      +                  "type": "boolean"
      +                },
      +                "deskCode": {
      +                  "type": "string"
      +                },
      +                "floor": {
      +                  "type": "string"
      +                },
      +                "floorSection": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "memberships": {
      +            "items": {
      +              "properties": {
      +                "contactGroupMembership": {
      +                  "properties": {
      +                    "contactGroupId": {
      +                      "type": "string"
      +                    },
      +                    "contactGroupResourceName": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "domainMembership": {
      +                  "properties": {
      +                    "inViewerDomain": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "metadata": {
      +            "properties": {
      +              "deleted": {
      +                "type": "boolean"
      +              },
      +              "linkedPeopleResourceNames": {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              "objectType": {
      +                "enum": [
      +                  "OBJECT_TYPE_UNSPECIFIED",
      +                  "PERSON",
      +                  "PAGE"
      +                ],
      +                "type": "string"
      +              },
      +              "previousResourceNames": {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              "sources": {
      +                "items": {
      +                  "properties": {
      +                    "etag": {
      +                      "type": "string"
      +                    },
      +                    "id": {
      +                      "type": "string"
      +                    },
      +                    "profileMetadata": {
      +                      "type": "object"
      +                    },
      +                    "type": {
      +                      "enum": [
      +                        "SOURCE_TYPE_UNSPECIFIED",
      +                        "ACCOUNT",
      +                        "PROFILE",
      +                        "DOMAIN_PROFILE",
      +                        "CONTACT",
      +                        "OTHER_CONTACT",
      +                        "DOMAIN_CONTACT"
      +                      ],
      +                      "type": "string"
      +                    },
      +                    "updateTime": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "miscKeywords": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "enum": [
      +                    "TYPE_UNSPECIFIED",
      +                    "OUTLOOK_BILLING_INFORMATION",
      +                    "OUTLOOK_DIRECTORY_SERVER",
      +                    "OUTLOOK_KEYWORD",
      +                    "OUTLOOK_MILEAGE",
      +                    "OUTLOOK_PRIORITY",
      +                    "OUTLOOK_SENSITIVITY",
      +                    "OUTLOOK_SUBJECT",
      +                    "OUTLOOK_USER",
      +                    "HOME",
      +                    "WORK",
      +                    "OTHER"
      +                  ],
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "names": {
      +            "items": {
      +              "properties": {
      +                "displayName": {
      +                  "type": "string"
      +                },
      +                "displayNameLastFirst": {
      +                  "type": "string"
      +                },
      +                "familyName": {
      +                  "type": "string"
      +                },
      +                "givenName": {
      +                  "type": "string"
      +                },
      +                "honorificPrefix": {
      +                  "type": "string"
      +                },
      +                "honorificSuffix": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "middleName": {
      +                  "type": "string"
      +                },
      +                "phoneticFamilyName": {
      +                  "type": "string"
      +                },
      +                "phoneticFullName": {
      +                  "type": "string"
      +                },
      +                "phoneticGivenName": {
      +                  "type": "string"
      +                },
      +                "phoneticHonorificPrefix": {
      +                  "type": "string"
      +                },
      +                "phoneticHonorificSuffix": {
      +                  "type": "string"
      +                },
      +                "phoneticMiddleName": {
      +                  "type": "string"
      +                },
      +                "unstructuredName": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "nicknames": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "enum": [
      +                    "DEFAULT",
      +                    "MAIDEN_NAME",
      +                    "INITIALS",
      +                    "GPLUS",
      +                    "OTHER_NAME",
      +                    "ALTERNATE_NAME",
      +                    "SHORT_NAME"
      +                  ],
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "occupations": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "organizations": {
      +            "items": {
      +              "properties": {
      +                "costCenter": {
      +                  "type": "string"
      +                },
      +                "current": {
      +                  "type": "boolean"
      +                },
      +                "department": {
      +                  "type": "string"
      +                },
      +                "domain": {
      +                  "type": "string"
      +                },
      +                "endDate": {
      +                  "properties": {
      +                    "day": {
      +                      "type": "integer"
      +                    },
      +                    "month": {
      +                      "type": "integer"
      +                    },
      +                    "year": {
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "fullTimeEquivalentMillipercent": {
      +                  "type": "integer"
      +                },
      +                "jobDescription": {
      +                  "type": "string"
      +                },
      +                "location": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "name": {
      +                  "type": "string"
      +                },
      +                "phoneticName": {
      +                  "type": "string"
      +                },
      +                "startDate": {
      +                  "properties": {
      +                    "day": {
      +                      "type": "integer"
      +                    },
      +                    "month": {
      +                      "type": "integer"
      +                    },
      +                    "year": {
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "symbol": {
      +                  "type": "string"
      +                },
      +                "title": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "phoneNumbers": {
      +            "items": {
      +              "properties": {
      +                "canonicalForm": {
      +                  "type": "string"
      +                },
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "photos": {
      +            "items": {
      +              "properties": {
      +                "default": {
      +                  "type": "boolean"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "url": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "relations": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "person": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "relationshipInterests": {
      +            "items": {
      +              "properties": {
      +                "formattedValue": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "relationshipStatuses": {
      +            "items": {
      +              "properties": {
      +                "formattedValue": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "residences": {
      +            "items": {
      +              "properties": {
      +                "current": {
      +                  "type": "boolean"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "resourceName": {
      +            "type": "string"
      +          },
      +          "sipAddresses": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "skills": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "taglines": {
      +            "items": {
      +              "properties": {
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "urls": {
      +            "items": {
      +              "properties": {
      +                "formattedType": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": {
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "userDefined": {
      +            "items": {
      +              "properties": {
      +                "key": {
      +                  "type": "string"
      +                },
      +                "metadata": {
      +                  "properties": {
      +                    "primary": {
      +                      "type": "boolean"
      +                    },
      +                    "source": {
      +                      "type": "object"
      +                    },
      +                    "sourcePrimary": {
      +                      "type": "boolean"
      +                    },
      +                    "verified": {
      +                      "type": "boolean"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden and does substantial work: it discloses deletion markers via PersonMetadata.deleted, a several-minute write-propagation delay for sync requests, and the read-after-write caveat. It omits auth/scopes and quota behavior, so it stops short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core is well front-loaded — scope first, then sync semantics. But it is padded with generic harness boilerplate about HTTP GET, body_file and typed-parameter precedence, plus a truncated markdown example link, none of which help an agent decide or call correctly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 11-parameter, no-annotation tool the sync/pagination contract is covered well and an output schema exists so return shape needn't be described. Still missing: that sources and readMask are required in practice, and any permission or scope context before an agent invokes it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 82%, so the baseline is 3. The description does add one rule beyond the schema ('all other request parameters must match the first call'), but it references 'sync_token'/'page_token' in snake_case while the schema uses syncToken/pageToken, and it never touches the required sources and readMask parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource: lists 'domain profiles and domain contacts in the authenticated user's domain directory,' which distinguishes it from personal-contact listing. However, the sibling tools are dumped as a flat comma list including searchDirectoryPeople and connections.list with no statement of how this differs from them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives real conditions for the sync path (sync_token returns deletions, other request parameters must match the first call, not intended for read-after-write), but says nothing about when to pick this tool over searchDirectoryPeople or connections.list, nor who can call it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools