Google Workspace website screenshot

Google Workspace

A collection of productivity and collaboration tools from Google including Gmail, Drive, Calendar, Meet, and more.

27 APIs 8 Features
CalendarCollaborationEmailProductivityStorageVideo Conferencing

APIs

Gmail API

Send and read email, manage drafts and labels, and handle mailbox settings.

Google Drive API

Store and synchronize files across devices, manage file metadata and permissions.

Google Calendar API

Create and manage calendars, events, and attendees.

Google Meet REST API

Create and manage video conferencing meetings, spaces, recordings, and transcripts.

Google Docs API

Create and edit documents programmatically.

Google Sheets API

Read and write data in Google Sheets.

Google Slides API

Create and modify presentations.

Admin SDK Directory API

Manage users, groups, organizational units, and devices in a Google Workspace domain.

Google Chat API

Build bots and integrations for Google Chat.

Admin SDK Reports API

View audit and usage reports for a Google Workspace domain including user activity and admin actions.

Google Forms API

Create and modify forms and quizzes, retrieve form responses and quiz grades.

Google Tasks API

Search, read, and update Google Tasks content and metadata.

Google Keep API

Manage Google Keep notes including creating, listing, and deleting notes and managing permissions.

Google Vault API

Manage eDiscovery for your organization including matters, holds, and exports across Google Workspace services.

Google Classroom API

Manage classes, rosters, invitations, and coursework in Google Classroom.

People API

Read and manage the authenticated user contacts and profiles, and search the directory.

Google Cloud Search API

Index non-Google Workspace data and search across all organizational data sources.

Drive Activity API

Retrieve information about changes made to objects within a user Google Drive.

Drive Labels API

Create and manage labels to organize and classify files in Google Drive.

Alert Center API

Manage alerts on issues affecting your Google Workspace domain including security and compliance warnings.

Groups Settings API

Update and retrieve settings for existing Google Groups including permissions and access controls.

Groups Migration API

Migrate shared emails from public folders and distribution lists to Google Groups discussion archives.

Admin SDK Data Transfer API

Transfer ownership of user data from one user to another within a domain.

Enterprise License Manager API

Manage Google Workspace and related product licenses for all users of a customer.

Google Workspace Reseller API

Perform common reseller functions at scale including placing orders and managing customer subscriptions.

Gmail Postmaster Tools API

Gather statistics on bulk emails sent to Gmail users including spam reports and delivery errors.

Google Workspace Marketplace API

Manage customer and user license status for Google Workspace Marketplace applications.

Collections

Google Workspace Admin SDK Directory API

POSTMAN

Google Workspace Admin SDK Directory API

OPEN

Arazzo Workflows

Google Workspace Audit a User's Group Memberships

Confirm a user exists, then list every group the user belongs to.

ARAZZO

Google Workspace Create a Group

Create a group with an email and description, then read it back.

ARAZZO

Google Workspace Create an Org Unit and Assign a User

Create an organizational unit, then move a user into it and confirm.

ARAZZO

Google Workspace Decommission an Org Unit

Move a user out of an org unit, then delete the now-empty unit.

ARAZZO

Google Workspace Delete a User Safely

Look up a user, confirm it exists, then delete the account.

ARAZZO

Google Workspace Find and Delete a Group

Search groups by query, branch on a match, then delete the group.

ARAZZO

Google Workspace Find and Update a User

Search users by query, branch on whether a match was found, then patch it.

ARAZZO

Google Workspace Inspect the Org Unit Tree

List all child org units under a path, then read the first one in detail.

ARAZZO

Google Workspace Move a User to Another Org Unit

Verify the target org unit exists, then move a user into it and confirm.

ARAZZO

Google Workspace Offboard a User

Suspend a departing user, sign them out of all sessions, and confirm the state.

ARAZZO

Google Workspace Promote a User to Super Administrator

Confirm a user exists, grant super admin, then verify the admin flag.

ARAZZO

Google Workspace Provision a User

Create a new user account, place it in an organizational unit, and read it back.

ARAZZO

Google Workspace Rename a Group

Read a group, patch its name and description, then confirm the change.

ARAZZO

Google Workspace Rename an Org Unit

Read an org unit, patch its name and description, then confirm.

ARAZZO

Google Workspace Reset a User Password

Confirm a user, set a new password forcing change at next login, sign them out.

ARAZZO

Google Workspace Restore a Deleted User

Find a recently deleted user, undelete it into an org unit, and confirm.

ARAZZO

Pricing Plans

Google Workspace Plans Pricing

4 plans

PLANS

Rate Limits

Google Workspace Rate Limits

7 limits

RATE LIMITS

FinOps

Google Workspace Finops

FINOPS

Features

Email and Communication

Send, receive, and manage email with Gmail API, build chat bots with Chat API, and host video meetings with Meet API.

Document Collaboration

Create and edit documents, spreadsheets, presentations, and forms programmatically across Google Workspace apps.

File Storage and Management

Store, sync, and manage files with Drive API including permissions, metadata, labels, and activity tracking.

Directory and User Management

Manage users, groups, organizational units, and devices across a Google Workspace domain with Admin SDK.

Calendar and Scheduling

Create and manage calendars, events, and attendees with automatic conflict detection and resource booking.

Security and Compliance

Monitor security alerts, manage eDiscovery holds, and generate audit reports for compliance requirements.

Enterprise Search

Index and search across Google Workspace and external data sources with Cloud Search API.

Task and Note Management

Manage tasks and notes programmatically with Tasks API and Keep API for productivity workflows.

Use Cases

Automated Onboarding

Provision user accounts, assign groups and licenses, and configure organizational units for new employee onboarding.

Document Workflow Automation

Automate document creation, approval workflows, and distribution using Docs, Sheets, and Drive APIs.

Meeting Management

Schedule meetings, manage recordings and transcripts, and integrate video conferencing into custom applications.

Security Monitoring

Monitor security alerts, audit user activity, and enforce compliance policies across the Google Workspace domain.

Customer Communication

Automate email campaigns, manage support inboxes, and integrate Gmail with CRM and helpdesk systems.

Integrations

Salesforce

Sync contacts, calendar events, and emails between Google Workspace and Salesforce CRM.

Slack

Bridge Google Workspace content and notifications with Slack channels for unified collaboration.

Microsoft 365

Interoperability support for document sharing and calendar synchronization with Microsoft Office apps.

Jira

Link Google Drive files, create documents from Jira issues, and sync calendar events with project timelines.

Zapier

Connect Google Workspace apps with thousands of services through Zapier automation workflows.

Asana

Integrate Google Drive attachments, Calendar events, and Gmail notifications with Asana project management.

Semantic Vocabularies

Admin Sdk Directory Context

0 classes · 0 properties

JSON-LD

Google Workspace Context

0 classes · 3 properties

JSON-LD

API Governance Rules

Google Workspace API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Admin Sdk Directory Error Structure

1 properties

JSON STRUCTURE

Admin Sdk Directory Group Structure

10 properties

JSON STRUCTURE

Admin Sdk Directory Groups Structure

4 properties

JSON STRUCTURE

Admin Sdk Directory Org Unit Structure

9 properties

JSON STRUCTURE

Admin Sdk Directory Org Units Structure

3 properties

JSON STRUCTURE

Admin Sdk Directory User Name Structure

4 properties

JSON STRUCTURE

Admin Sdk Directory User Structure

41 properties

JSON STRUCTURE

Admin Sdk Directory Users Structure

5 properties

JSON STRUCTURE

Google Workspace Structure

0 properties

JSON STRUCTURE

Example Payloads

Admin Sdk Directory Error Example

1 fields

EXAMPLE

Admin Sdk Directory Group Example

10 fields

EXAMPLE

Admin Sdk Directory Groups Example

4 fields

EXAMPLE

Admin Sdk Directory Org Unit Example

9 fields

EXAMPLE

Admin Sdk Directory Org Units Example

3 fields

EXAMPLE

Admin Sdk Directory User Example

41 fields

EXAMPLE

Admin Sdk Directory User Name Example

4 fields

EXAMPLE

Admin Sdk Directory Users Example

5 fields

EXAMPLE

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🌐
Console
Console
🔑
Authentication
Authentication
📜
TermsOfService
TermsOfService
💬
Support
Support
🟢
StatusPage
StatusPage
🌐
DeveloperPortal
DeveloperPortal
💰
Pricing
Pricing
📰
Blog
Blog
📄
ReleaseNotes
ReleaseNotes
🚀
GettingStarted
GettingStarted
📦
SDKs
SDKs

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Google Workspace Admin SDK Directory API
  version: directory_v1
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
    accessTokenUrl: https://oauth2.googleapis.com/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Users
    type: folder
  items:
  - info:
      name: List Users
      type: http
    http:
      method: GET
      url: https://admin.googleapis.com/admin/directory/v1/users
      params:
      - name: domain
        value: ''
        type: query
        description: The domain name. Use this field to get groups from only one domain. To return all domains for a customer
          account, use the customer query parameter instead.
      - name: customer
        value: ''
        type: query
        description: The unique ID for the customer Google Workspace account. In a multi-domain account, use this to list
          all groups for a customer. You can also use the my_customer alias.
      - name: maxResults
        value: ''
        type: query
        description: Maximum number of results to return (1-500). Default is 100.
      - name: pageToken
        value: ''
        type: query
        description: Token to specify the next page in the list.
      - name: orderBy
        value: ''
        type: query
        description: Property to use for sorting results.
      - name: sortOrder
        value: ''
        type: query
        description: Whether to return results in ascending or descending order.
      - name: query
        value: ''
        type: query
        description: Query string for searching user fields. For more information on constructing user queries, see the Search
          for Users documentation.
      - name: showDeleted
        value: ''
        type: query
        description: If set to true, retrieves the list of deleted users.
      - name: projection
        value: ''
        type: query
        description: What subset of fields to fetch for this user.
      - name: viewType
        value: ''
        type: query
        description: Whether to fetch the administrator-only or domain-wide public view of the user. Default is admin_view.
      - name: customFieldMask
        value: ''
        type: query
        description: A comma-separated list of schema names. All fields from these schemas are fetched. Must be set when projection=custom.
    docs: Retrieves a paginated list of either deleted users or all users in a domain. Requires authorization with the admin.directory.user.readonly
      or admin.directory.user scope.
  - info:
      name: Create a User
      type: http
    http:
      method: POST
      url: https://admin.googleapis.com/admin/directory/v1/users
      body:
        type: json
        data: '{}'
    docs: Creates a user account. The new user account is created in the customer account specified in the request body.
  - info:
      name: Get a User
      type: http
    http:
      method: GET
      url: https://admin.googleapis.com/admin/directory/v1/users/:userKey
      params:
      - name: userKey
        value: ''
        type: path
        description: Identifies the user in the API request. The value can be the user primary email address, alias email
          address, or unique user ID.
      - name: projection
        value: ''
        type: query
        description: What subset of fields to fetch for this user.
      - name: viewType
        value: ''
        type: query
        description: Whether to fetch the administrator-only or domain-wide public view of the user.
      - name: customFieldMask
        value: ''
        type: query
        description: A comma-separated list of schema names. All fields from these schemas are fetched. Must be set when projection=custom.
    docs: Retrieves a user account by user key (primary email address, alias email address, or unique user ID).
  - info:
      name: Update a User
      type: http
    http:
      method: PUT
      url: https://admin.googleapis.com/admin/directory/v1/users/:userKey
      params:
      - name: userKey
        value: ''
        type: path
        description: Identifies the user in the API request. The value can be the user primary email address, alias email
          address, or unique user ID.
      body:
        type: json
        data: '{}'
    docs: Updates a user account. This replaces the entire user resource. Use patch for partial updates.
  - info:
      name: Patch a User
      type: http
    http:
      method: PATCH
      url: https://admin.googleapis.com/admin/directory/v1/users/:userKey
      params:
      - name: userKey
        value: ''
        type: path
        description: Identifies the user in the API request. The value can be the user primary email address, alias email
          address, or unique user ID.
      body:
        type: json
        data: '{}'
    docs: Updates a user account using patch semantics. Only the fields specified in the request body are updated.
  - info:
      name: Delete a User
      type: http
    http:
      method: DELETE
      url: https://admin.googleapis.com/admin/directory/v1/users/:userKey
      params:
      - name: userKey
        value: ''
        type: path
        description: Identifies the user in the API request. The value can be the user primary email address, alias email
          address, or unique user ID.
    docs: Deletes a user account. Deleted users are recoverable for a period of 20 days using the undelete method.
  - info:
      name: Make a User a Super Administrator
      type: http
    http:
      method: POST
      url: https://admin.googleapis.com/admin/directory/v1/users/:userKey/makeAdmin
      params:
      - name: userKey
        value: ''
        type: path
        description: Identifies the user in the API request. The value can be the user primary email address, alias email
          address, or unique user ID.
      body:
        type: json
        data: '{}'
    docs: Makes a user a super administrator. This can only be done by another super administrator.
  - info:
      name: Undelete a User
      type: http
    http:
      method: POST
      url: https://admin.googleapis.com/admin/directory/v1/users/:userKey/undelete
      params:
      - name: userKey
        value: ''
        type: path
        description: Identifies the user in the API request. The value can be the user primary email address, alias email
          address, or unique user ID.
      body:
        type: json
        data: '{}'
    docs: Restores a recently deleted user account. Users are recoverable for a period of 20 days after deletion.
  - info:
      name: Sign Out a User
      type: http
    http:
      method: POST
      url: https://admin.googleapis.com/admin/directory/v1/users/:userKey/signOut
      params:
      - name: userKey
        value: ''
        type: path
        description: Identifies the user in the API request. The value can be the user primary email address, alias email
          address, or unique user ID.
    docs: Signs a user out of all web and device sessions and resets their sign-in cookies.
- info:
    name: Groups
    type: folder
  items:
  - info:
      name: List Groups
      type: http
    http:
      method: GET
      url: https://admin.googleapis.com/admin/directory/v1/groups
      params:
      - name: domain
        value: ''
        type: query
        description: The domain name. Use this field to get groups from only one domain. To return all domains for a customer
          account, use the customer query parameter instead.
      - name: customer
        value: ''
        type: query
        description: The unique ID for the customer Google Workspace account. In a multi-domain account, use this to list
          all groups for a customer. You can also use the my_customer alias.
      - name: maxResults
        value: ''
        type: query
        description: Maximum number of results to return (1-200). Default is 200.
      - name: pageToken
        value: ''
        type: query
        description: Token to specify the next page in the list.
      - name: orderBy
        value: ''
        type: query
        description: Column to use for sorting results.
      - name: sortOrder
        value: ''
        type: query
        description: Whether to return results in ascending or descending order.
      - name: userKey
        value: ''
        type: query
        description: Email or immutable ID of the user to list groups for. If specified, returns only those groups the user
          is a member of.
      - name: query
        value: ''
        type: query
        description: Query string for searching group fields. See the Searching for Groups documentation for supported fields.
    docs: Retrieves all groups of a domain or all groups a user is a member of. Requires authorization with the admin.directory.group.readonly
      or admin.directory.group scope.
  - info:
      name: Create a Group
      type: http
    http:
      method: POST
      url: https://admin.googleapis.com/admin/directory/v1/groups
      body:
        type: json
        data: '{}'
    docs: Creates a group in the specified domain.
  - info:
      name: Get a Group
      type: http
    http:
      method: GET
      url: https://admin.googleapis.com/admin/directory/v1/groups/:groupKey
      params:
      - name: groupKey
        value: ''
        type: path
        description: Identifies the group in the API request. The value can be the group email address, group alias, or the
          unique group ID.
    docs: Retrieves a group's properties by group key (group email address, group alias, or the unique group ID).
  - info:
      name: Update a Group
      type: http
    http:
      method: PUT
      url: https://admin.googleapis.com/admin/directory/v1/groups/:groupKey
      params:
      - name: groupKey
        value: ''
        type: path
        description: Identifies the group in the API request. The value can be the group email address, group alias, or the
          unique group ID.
      body:
        type: json
        data: '{}'
    docs: Updates a group's properties. This replaces the entire group resource.
  - info:
      name: Patch a Group
      type: http
    http:
      method: PATCH
      url: https://admin.googleapis.com/admin/directory/v1/groups/:groupKey
      params:
      - name: groupKey
        value: ''
        type: path
        description: Identifies the group in the API request. The value can be the group email address, group alias, or the
          unique group ID.
      body:
        type: json
        data: '{}'
    docs: Updates a group's properties using patch semantics. Only the specified fields are updated.
  - info:
      name: Delete a Group
      type: http
    http:
      method: DELETE
      url: https://admin.googleapis.com/admin/directory/v1/groups/:groupKey
      params:
      - name: groupKey
        value: ''
        type: path
        description: Identifies the group in the API request. The value can be the group email address, group alias, or the
          unique group ID.
    docs: Deletes a group.
- info:
    name: OrgUnits
    type: folder
  items:
  - info:
      name: List Organizational Units
      type: http
    http:
      method: GET
      url: https://admin.googleapis.com/admin/directory/v1/customer/:customerId/orgunits
      params:
      - name: customerId
        value: ''
        type: path
        description: The unique ID for the customer Google Workspace account. Use the value my_customer to represent the account
          associated with the authenticated administrator.
      - name: type
        value: ''
        type: query
        description: Whether to return all sub-organizations or just immediate children.
      - name: orgUnitPath
        value: ''
        type: query
        description: The full path to the organizational unit or its unique ID. Returns child organizational units beneath
          the specified path.
    docs: Retrieves a list of all organizational units for an account. The hierarchy of organizational units is limited to
      35 levels of depth.
  - info:
      name: Create an Organizational Unit
      type: http
    http:
      method: POST
      url: https://admin.googleapis.com/admin/directory/v1/customer/:customerId/orgunits
      params:
      - name: customerId
        value: ''
        type: path
        description: The unique ID for the customer Google Workspace account. Use the value my_customer to represent the account
          associated with the authenticated administrator.
      body:
        type: json
        data: '{}'
    docs: Adds an organizational unit under the specified customer account.
  - info:
      name: Get an Organizational Unit
      type: http
    http:
      method: GET
      url: https://admin.googleapis.com/admin/directory/v1/customer/:customerId/orgunits/:orgUnitPath
      params:
      - name: customerId
        value: ''
        type: path
        description: The unique ID for the customer Google Workspace account. Use the value my_customer to represent the account
          associated with the authenticated administrator.
      - name: orgUnitPath
        value: ''
        type: path
        description: The full path of the organizational unit (minus the leading /) or its unique ID.
    docs: Retrieves an organizational unit.
  - info:
      name: Update an Organizational Unit
      type: http
    http:
      method: PUT
      url: https://admin.googleapis.com/admin/directory/v1/customer/:customerId/orgunits/:orgUnitPath
      params:
      - name: customerId
        value: ''
        type: path
        description: The unique ID for the customer Google Workspace account. Use the value my_customer to represent the account
          associated with the authenticated administrator.
      - name: orgUnitPath
        value: ''
        type: path
        description: The full path of the organizational unit (minus the leading /) or its unique ID.
      body:
        type: json
        data: '{}'
    docs: Updates an organizational unit. This replaces the entire resource. Use patch for partial updates.
  - info:
      name: Patch an Organizational Unit
      type: http
    http:
      method: PATCH
      url: https://admin.googleapis.com/admin/directory/v1/customer/:customerId/orgunits/:orgUnitPath
      params:
      - name: customerId
        value: ''
        type: path
        description: The unique ID for the customer Google Workspace account. Use the value my_customer to represent the account
          associated with the authenticated administrator.
      - name: orgUnitPath
        value: ''
        type: path
        description: The full path of the organizational unit (minus the leading /) or its unique ID.
      body:
        type: json
        data: '{}'
    docs: Updates an organizational unit using patch semantics. Only the specified fields are updated.
  - info:
      name: Delete an Organizational Unit
      type: http
    http:
      method: DELETE
      url: https://admin.googleapis.com/admin/directory/v1/customer/:customerId/orgunits/:orgUnitPath
      params:
      - name: customerId
        value: ''
        type: path
        description: The unique ID for the customer Google Workspace account. Use the value my_customer to represent the account
          associated with the authenticated administrator.
      - name: orgUnitPath
        value: ''
        type: path
        description: The full path of the organizational unit (minus the leading /) or its unique ID.
    docs: Removes an organizational unit. Only empty organizational units can be deleted. All users and child organizational
      units must be moved or deleted before the parent can be removed.
bundled: true