Google Lists API

Operations related to Lists

OpenAPI Specification

google-lists-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Books About Lists API
  description: API for retrieving Bookshelf and Volume resources from Google Books
  version: 1.0.0
  contact:
    name: Google Books API
    url: https://developers.google.com/books
servers:
- url: https://www.googleapis.com/books/v1
  description: Google Books API v1
tags:
- name: Lists
  description: Operations related to Lists
paths:
  /gmail/v1/users/{userId}/drafts:
    get:
      tags:
      - Lists
      summary: Google List Drafts
      description: Lists the drafts in the user's mailbox.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{userID}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GmailUsersDraftsGetResponse1'
              examples:
                GmailUsersDraftsGetResponse1Example:
                  $ref: '#/components/examples/GmailUsersDraftsGetResponse1Example'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: GmailUsersDraftsGetResponse1Example
  /gmail/v1/users/{userId}/history:
    get:
      tags:
      - Lists
      summary: Google List History
      description: Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`).
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{userId}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GmailUsersHistoryGetResponse'
              examples:
                GmailUsersHistoryGetResponseExample:
                  $ref: '#/components/examples/GmailUsersHistoryGetResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: GmailUsersHistoryGetResponseExample
  /gmail/v1/users/{userId}/messages:
    get:
      tags:
      - Lists
      summary: Google List Messages
      description: Lists the messages in the user's mailbox.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: maxResults
        in: query
        schema:
          type: string
        example: '{{maxResults}}'
      - name: pageToken
        in: query
        schema:
          type: string
        example: '{{pageToken}}'
      - name: q
        in: query
        schema:
          type: string
        example: '{{q}}'
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{userId}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GmailUsersMessagesGetResponse'
              examples:
                GmailUsersMessagesGetResponseExample:
                  $ref: '#/components/examples/GmailUsersMessagesGetResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: GmailUsersMessagesGetResponseExample
  /gmail/v1/users/{userId}/labels:
    get:
      tags:
      - Lists
      summary: Google List Labels
      description: Lists all labels in the user's mailbox.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GmailUsersLabelsGetResponse'
              examples:
                GmailUsersLabelsGetResponseExample:
                  $ref: '#/components/examples/GmailUsersLabelsGetResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: GmailUsersLabelsGetResponseExample
  /gmail/v1/users/{userId}/threads:
    get:
      tags:
      - Lists
      summary: Google List Threads
      description: Lists the threads in the user's mailbox.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{userID}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GmailUsersThreadsGetResponse1'
              examples:
                GmailUsersThreadsGetResponse1Example:
                  $ref: '#/components/examples/GmailUsersThreadsGetResponse1Example'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: GmailUsersThreadsGetResponse1Example
  /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo:
    get:
      tags:
      - Lists
      summary: Google List SMIME Info
      description: Lists S/MIME configs for the specified send-as alias.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      - name: sendAsEmail
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsSendAsSmimeInfoGetResponse1'
              examples:
                SettingsSendAsSmimeInfoGetResponse1Example:
                  $ref: '#/components/examples/SettingsSendAsSmimeInfoGetResponse1Example'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SettingsSendAsSmimeInfoGetResponse1Example
  /gmail/v1/users/{userId}/settings/cse/keypairs:
    get:
      tags:
      - Lists
      summary: Google List CSE Keypairs
      description: Lists client-side encryption key pairs for an authenticated user.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsCseKeypairsGetResponse1'
              examples:
                SettingsCseKeypairsGetResponse1Example:
                  $ref: '#/components/examples/SettingsCseKeypairsGetResponse1Example'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SettingsCseKeypairsGetResponse1Example
  /gmail/v1/users/{userId}/settings/cse/identities:
    get:
      tags:
      - Lists
      summary: Google List CSE Identites
      description: Lists the client-side encrypted identities for an authenticated user.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsCseIdentitiesGetResponse'
              examples:
                SettingsCseIdentitiesGetResponseExample:
                  $ref: '#/components/examples/SettingsCseIdentitiesGetResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SettingsCseIdentitiesGetResponseExample
  /gmail/v1/users/{userId}/settings/filters:
    get:
      tags:
      - Lists
      summary: Google List Filters
      description: Lists the message filters of a Gmail user.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsFiltersGetResponse1'
              examples:
                UsersSettingsFiltersGetResponse1Example:
                  $ref: '#/components/examples/UsersSettingsFiltersGetResponse1Example'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsFiltersGetResponse1Example
  /gmail/v1/users/{userId}/settings/forwardingAddresses:
    get:
      tags:
      - Lists
      summary: Google List Forwarding Addresses
      description: Lists the forwarding addresses for the specified account.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsForwardingAddressesGetResponse1'
              examples:
                UsersSettingsForwardingAddressesGetResponse1Example:
                  $ref: '#/components/examples/UsersSettingsForwardingAddressesGetResponse1Example'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsForwardingAddressesGetResponse1Example
  /gmail/v1/users/{userId}/settings/delegates:
    get:
      tags:
      - Lists
      summary: Google List Delegates
      description: Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsDelegatesGetResponse1'
              examples:
                UsersSettingsDelegatesGetResponse1Example:
                  $ref: '#/components/examples/UsersSettingsDelegatesGetResponse1Example'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsDelegatesGetResponse1Example
components:
  schemas:
    SettingsSendAsSmimeInfoGetResponse1:
      description: SettingsSendAsSmimeInfoGetResponse1 schema
      type: object
      properties:
        smimeInfo:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              issuerCn:
                type: string
              isDefault:
                type: boolean
              expiration:
                type: string
              pem:
                type: string
              pkcs12:
                type: string
              encryptedKeyPassword:
                type: string
    GmailUsersDraftsGetResponse1:
      description: GmailUsersDraftsGetResponse1 schema
      type: object
      properties:
        drafts:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              message:
                type: object
                properties:
                  id:
                    type: string
                  threadId:
                    type: string
                  labelIds:
                    type: array
                    items:
                      type: string
                  snippet:
                    type: string
                  historyId:
                    type: string
                  internalDate:
                    type: string
                  payload:
                    type: object
                    properties:
                      partId:
                        type: string
                      mimeType:
                        type: string
                      filename:
                        type: string
                      headers:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            value:
                              type: string
                      body:
                        type: object
                        properties:
                          attachmentId:
                            type: string
                          size:
                            type: integer
                          data:
                            type: string
                      parts:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              type: string
                  sizeEstimate:
                    type: integer
                  raw:
                    type: string
        nextPageToken:
          type: string
        resultSizeEstimate:
          type: integer
    SettingsCseIdentitiesGetResponse:
      description: SettingsCseIdentitiesGetResponse schema
      type: object
      properties:
        cseIdentities:
          type: array
          items:
            type: object
            properties:
              emailAddress:
                type: string
              primaryKeyPairId:
                type: string
              signAndEncryptKeyPairs:
                type: object
                properties:
                  signingKeyPairId:
                    type: string
                  encryptionKeyPairId:
                    type: string
        nextPageToken:
          type: string
    SettingsCseKeypairsGetResponse1:
      description: SettingsCseKeypairsGetResponse1 schema
      type: object
      properties:
        cseKeyPairs:
          type: array
          items:
            type: object
            properties:
              keyPairId:
                type: string
              pkcs7:
                type: string
              pem:
                type: string
              subjectEmailAddresses:
                type: array
                items:
                  type: string
              enablementState:
                type: string
              disableTime:
                type: string
              privateKeyMetadata:
                type: array
                items:
                  type: object
                  properties:
                    privateKeyMetadataId:
                      type: string
                    kaclsKeyMetadata:
                      type: object
                      properties:
                        kaclsUri:
                          type: string
                        kaclsData:
                          type: string
                    hardwareKeyMetadata:
                      type: object
                      properties:
                        description:
                          type: string
        nextPageToken:
          type: string
    GmailUsersHistoryGetResponse:
      description: GmailUsersHistoryGetResponse schema
      type: object
      properties:
        history:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              messages:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    threadId:
                      type: string
                    labelIds:
                      type: array
                      items:
                        type: string
                    snippet:
                      type: string
                    historyId:
                      type: string
                    internalDate:
                      type: string
                    payload:
                      type: object
                      properties:
                        partId:
                          type: string
                        mimeType:
                          type: string
                        filename:
                          type: string
                        headers:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              value:
                                type: string
                        body:
                          type: object
                          properties:
                            attachmentId:
                              type: string
                            size:
                              type: integer
                            data:
                              type: string
                        parts:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                    sizeEstimate:
                      type: integer
                    raw:
                      type: string
              messagesAdded:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: object
                      properties:
                        id:
                          type: string
                        threadId:
                          type: string
                        labelIds:
                          type: array
                          items:
                            type: string
                        snippet:
                          type: string
                        historyId:
                          type: string
                        internalDate:
                          type: string
                        payload:
                          type: object
                          properties:
                            partId:
                              type: string
                            mimeType:
                              type: string
                            filename:
                              type: string
                            headers:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  value:
                                    type: string
                            body:
                              type: object
                              properties:
                                attachmentId:
                                  type: string
                                size:
                                  type: integer
                                data:
                                  type: string
                            parts:
                              type: array
                              items:
                                type: object
                                properties:
                                  value:
                                    type: string
                        sizeEstimate:
                          type: integer
                        raw:
                          type: string
              messagesDeleted:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: object
                      properties:
                        id:
                          type: string
                        threadId:
                          type: string
                        labelIds:
                          type: array
                          items:
                            type: string
                        snippet:
                          type: string
                        historyId:
                          type: string
                        internalDate:
                          type: string
                        payload:
                          type: object
                          properties:
                            partId:
                              type: string
                            mimeType:
                              type: string
                            filename:
                              type: string
                            headers:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  value:
                                    type: string
                            body:
                              type: object
                              properties:
                                attachmentId:
                                  type: string
                                size:
                                  type: integer
                                data:
                                  type: string
                            parts:
                              type: array
                              items:
                                type: object
                                properties:
                                  value:
                                    type: string
                        sizeEstimate:
                          type: integer
                        raw:
                          type: string
              labelsAdded:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: object
                      properties:
                        id:
                          type: string
                        threadId:
                          type: string
                        labelIds:
                          type: array
                          items:
                            type: string
                        snippet:
                          type: string
                        historyId:
                          type: string
                        internalDate:
                          type: string
                        payload:
                          type: object
                          properties:
                            partId:
                              type: string
                            mimeType:
                              type: string
                            filename:
                              type: string
                            headers:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  value:
                                    type: string
                            body:
                              type: object
                              properties:
                                attachmentId:
                                  type: string
                                size:
                                  type: integer
                                data:
                                  type: string
                            parts:
                              type: array
                              items:
                                type: object
                                properties:
                                  value:
                                    type: string
                        sizeEstimate:
                          type: integer
                        raw:
                          type: string
                    labelIds:
                      type: array
                      items:
                        type: string
              labelsRemoved:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: object
                      properties:
                        id:
                          type: string
                        threadId:
                          type: string
                        labelIds:
                          type: array
                          items:
                            type: string
                        snippet:
                          type: string
                        historyId:
                          type: string
                        internalDate:
                          type: string
                        payload:
                          type: object
                          properties:
                            partId:
                              type: string
                            mimeType:
                              type: string
                            filename:
                              type: string
                            headers:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  value:
                                    type: string
                            body:
                              type: object
                              properties:
                                attachmentId:
                                  type: string
                                size:
                                  type: integer
                                data:
                                  type: string
                            parts:
                              type: array
                              items:
                                type: object
                                properties:
                                  value:
                                    type: string
                        sizeEstimate:
                          type: integer
                        raw:
                          type: string
                    labelIds:
                      type: array
                      items:
                        type: string
        nextPageToken:
          type: string
        historyId:
          type: string
    UsersSettingsDelegatesGetResponse1:
      description: UsersSettingsDelegatesGetResponse1 schema
      type: object
      properties:
        delegates:
          type: array
          items:
            type: object
            properties:
              delegateEmail:
                type: string
              verificationStatus:
                type: string
    GmailUsersThreadsGetResponse1:
      description: GmailUsersThreadsGetResponse1 schema
      type: object
      properties:
        threads:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              snippet:
                type: string
              historyId:
                type: string
              messages:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    threadId:
                      type: string
                    labelIds:
                      type: array
                      items:
                        type: string
                    snippet:
                      type: string
                    historyId:
                      type: string
                    internalDate:
                      type: string
                    payload:
                      type: object
                      properties:
                        partId:
                          type: string
                        mimeType:
                          type: string
                        filename:
                          type: string
                        headers:
                          type: array
                          items:
                           

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/google/refs/heads/main/openapi/google-lists-api-openapi.yml