Method: schemas.get

Retrieve schema

HTTP request

GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/schemas/{schemaKey}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Immutable ID of the Google Workspace account.
schemaKey

string

Name or immutable ID of the schema.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Schema.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/admin.directory.userschema
  • https://www.googleapis.com/auth/admin.directory.userschema.readonly

For more information, see the OAuth 2.0 Overview.