Google Admin SDK Admin Sdk Reseller Customers API

The Admin Sdk Reseller Customers API from Google Admin SDK — 2 operation(s) for admin sdk reseller customers.

GitHub OpenAPI

Operations 4

POST /apps/reseller/v1/customers Insert customers #
PUT /apps/reseller/v1/customers/{customerId} Update customers #
GET /apps/reseller/v1/customers/{customerId} Get customers #
PATCH /apps/reseller/v1/customers/{customerId} Patch customers #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/google-admin-sdk:google-admin-sdk-reseller-customers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

google-admin-sdk-reseller-customers-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Workspace Reseller API Customers API
  version: v1
  description: Generated from Google's published Discovery document for Google Workspace Reseller API (reseller v1, revision
    20261106). 4 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
externalDocs:
  url: https://developers.google.com/google-apps/reseller/
servers:
- url: https://reseller.googleapis.com
paths:
  /apps/reseller/v1/customers:
    post:
      operationId: reseller.customers.insert
      summary: Insert customers
      description: Orders a new customer's account. Before ordering a new customer account, establish whether the customer
        account already exists using the [`customers.get`](https://developers.google.com/workspace/admin/reseller/v1/reference/customers/get)
        If the customer account exists as a direct Google account or as a resold customer account from another reseller, use
        the `customerAuthToken\` as described in [order a resold account for an existing customer](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#create_existing_customer).
        For more information about ordering a new customer account, see [order a new customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#create_customer).
        After creating a new customer account, you must provision a user as an administrator. The customer's administrator
        is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers
        are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see
        [order a new customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#tos).
      parameters:
      - name: customerAuthToken
        in: query
        required: false
        description: The `customerAuthToken` query string is required when creating a resold account that transfers a direct
          customer's subscription or transfers another reseller customer's subscription to your reseller management. This
          is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the
          administrator help center.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Customer'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        4XX:
          content: &id001
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id001
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/apps.order
      - apiKey: []
      tags:
      - Customers
  /apps/reseller/v1/customers/{customerId}:
    put:
      operationId: reseller.customers.update
      summary: Update customers
      description: Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a `"team"`
        customer can verify their domain and become `customerType = "domain"`. For more information, see [update a customer's
        settings](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#update_customer).
      parameters:
      - name: customerId
        in: path
        required: true
        description: This can be either the customer's primary domain name or the customer's unique identifier. If the domain
          name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique
          identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems
          where applicable.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Customer'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        4XX:
          content: &id002
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id002
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/apps.order
      - apiKey: []
      tags:
      - Customers
    get:
      operationId: reseller.customers.get
      summary: Get customers
      description: Gets a customer account. Use this operation to see a customer account already in your reseller management,
        or to see the minimal account information for an existing customer that you do not manage. For more information about
        the API response for existing customers, see [retrieving a customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#get_customer).
      parameters:
      - name: customerId
        in: path
        required: true
        description: This can be either the customer's primary domain name or the customer's unique identifier. If the domain
          name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique
          identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems
          where applicable.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        4XX:
          content: &id003
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id003
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/apps.order
        - https://www.googleapis.com/auth/apps.order.readonly
      - apiKey: []
      tags:
      - Customers
    patch:
      operationId: reseller.customers.patch
      summary: Patch customers
      description: Updates a customer account's settings. This method supports patch semantics. You cannot update `customerType`
        via the Reseller API, but a `"team"` customer can verify their domain and become `customerType = "domain"`. For more
        information, see [Verify your domain to unlock Essentials features](https://support.google.com/a/answer/9122284).
      parameters:
      - name: customerId
        in: path
        required: true
        description: This can be either the customer's primary domain name or the customer's unique identifier. If the domain
          name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique
          identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems
          where applicable.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Customer'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        4XX:
          content: &id004
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id004
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/apps.order
      - apiKey: []
      tags:
      - Customers
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/apps.order: Manage users on your domain
            https://www.googleapis.com/auth/apps.order.readonly: Manage users on your domain
  schemas:
    Address:
      properties:
        organizationName:
          type: string
          description: The company or company division name. This is required.
        addressLine3:
          type: string
          description: Line 3 of the address.
        addressLine1:
          description: A customer's physical address. An address can be composed of one to three lines. The `addressline2`
            and `addressLine3` are optional.
          type: string
        addressLine2:
          type: string
          description: Line 2 of the address.
        kind:
          description: 'Identifies the resource as a customer address. Value: `customers#address`'
          default: customers#address
          type: string
        locality:
          description: An example of a `locality` value is the city of `San Francisco`.
          type: string
        postalCode:
          type: string
          description: A `postalCode` example is a postal zip code such as `94043`. This property is required when creating
            a new customer.
        contactName:
          type: string
          description: The customer contact's name. This is required.
        region:
          type: string
          description: An example of a `region` value is `CA` for the state of California.
        countryCode:
          description: For `countryCode` information, see the ISO 3166 country code elements. Verify that country is approved
            for resale of Google products. This property is required when creating a new customer.
          type: string
      type: object
      description: JSON template for address of a customer.
    Customer:
      properties:
        kind:
          description: 'Identifies the resource as a customer. Value: `reseller#customer`'
          type: string
          default: reseller#customer
        postalAddress:
          $ref: '#/components/schemas/Address'
          description: A customer's address information. Each field has a limit of 255 charcters.
        primaryAdmin:
          $ref: '#/components/schemas/PrimaryAdmin'
          description: The first admin details of the customer, present in case of TEAM customer.
        phoneNumber:
          type: string
          description: Customer contact phone number. Must start with "+" followed by the country code. The rest of the number
            can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and
            not, for example, "123". This field is silently ignored if invalid.
        customerType:
          enum:
          - customerTypeUnspecified
          - domain
          - team
          description: 'Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified
            customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).'
          type: string
        resourceUiUrl:
          type: string
          description: URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This
            is used if your client application requires the customer to complete a task in the Admin console.
        customerId:
          description: This property will always be returned in a response as the unique identifier generated by Google. In
            a request, this property can be either the primary domain or the unique identifier generated by Google.
          type: string
        customerDomainVerified:
          type: boolean
          description: Whether the customer's primary domain has been verified.
        customerDomain:
          description: The customer's primary domain name string. `customerDomain` is required when creating a new customer.
            Do not include the `www` prefix in the domain when adding a customer.
          type: string
        alternateEmail:
          type: string
          description: Like the "Customer email" in the reseller tools, this email is the secondary contact used if something
            happens to the customer's service such as service outage or a security issue. This property is required when creating
            a new "domain" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is
            not necessary to create a "team" customer.
      type: object
      description: When a Google customer's account is registered with a reseller, the customer's subscriptions for Google
        services are managed by this reseller. A customer is described by a primary domain name and a physical address.
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    PrimaryAdmin:
      description: JSON template for primary admin in case of TEAM customers
      properties:
        primaryEmail:
          type: string
          description: The business email of the primary administrator of the customer. The email verification link is sent
            to this email address at the time of customer creation. Primary administrators have access to the customer's Admin
            Console, including the ability to invite and evict users and manage the administrative needs of the customer.
      type: object
x-provenance:
  method: harvested
  publisher: Google
  source: https://reseller.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)