Google History API

Operations related to History

OpenAPI Specification

google-history-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Books About History 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: History
  description: Operations related to History
paths:
  /gmail/v1/users/{userId}/history:
    get:
      tags:
      - History
      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
components:
  schemas:
    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
  examples:
    GmailUsersHistoryGetResponseExample:
      summary: Successful 200 response
      value:
        history:
        - id: proident pariatur aute Lorem
          messages:
          - id: eiusmod id nisi
            threadId: anim et do
            labelIds:
            - e
            - non magna in id
            snippet: in
            historyId: dolor voluptate ex mollit
            internalDate: occaecat elit velit
            payload:
              partId: anim pariatur
              mimeType: sint cillum nulla incididunt
              filename: sed consequat esse eu
              headers:
              - name: amet ad Ut labore
                value: nisi deserunt
              - name: exercitation ex
                value: amet
              body:
                attachmentId: aliquip sunt ad in
                size: 49473554
                data: aliqua ea dolor nostrud
              parts:
              - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              - value: '<Circular reference to #/components/schemas/MessagePart detected>'
            sizeEstimate: -46841497
            raw: f
          - id: fugiat minim veniam sed
            threadId: ipsum officia magna irure
            labelIds:
            - sunt
            - velit consectetur magna
            snippet: voluptate
            historyId: et proident sunt in
            internalDate: non adipisicing
            payload:
              partId: in ullamco
              mimeType: labore Excepteur
              filename: pariatur commodo
              headers:
              - name: nostrud minim tempor Lorem
                value: aliquip id qui
              - name: nisi sit veniam
                value: et ipsum
              body:
                attachmentId: do sit
                size: 66422063
                data: non do aliquip ea sit
              parts:
              - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              - value: '<Circular reference to #/components/schemas/MessagePart detected>'
            sizeEstimate: -37565359
            raw: veniam laboris enim ullamco
          messagesAdded:
          - message:
              id: non fugiat Ut magna ullamco
              threadId: ut exercitation elit
              labelIds:
              - irure Excepteur do
              - nulla sed adipisicing enim
              snippet: minim
              historyId: adipisicing velit consequat
              internalDate: laborum nisi
              payload:
                partId: sed enim i
                mimeType: tempor esse dolor in nulla
                filename: sunt commodo
                headers:
                - name: Lorem
                  value: Ut dolore reprehenderit
                - name: tempor fugiat minim consectetur
                  value: aliquip
                body:
                  attachmentId: dolore quis exercitation
                  size: -24042089
                  data: exercitation aliqua
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: -38447430
              raw: culpa nisi ullamco aliquip
          - message:
              id: labore ullamco Excepteur laboris enim
              threadId: proident off
              labelIds:
              - 'cillum '
              - Lorem incididunt ullamco ipsum
              snippet: Lorem laborum
              historyId: qui mollit
              internalDate: ad commodo minim
              payload:
                partId: commodo dolor do
                mimeType: ad nisi
                filename: es
                headers:
                - name: sunt enim
                  value: ipsum
                - name: elit fugiat dolore aute
                  value: mollit Ut
                body:
                  attachmentId: ea reprehenderit
                  size: 2087603
                  data: in
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: -15899428
              raw: voluptate dolor laboris ad
          messagesDeleted:
          - message:
              id: Duis elit in
              threadId: fugiat
              labelIds:
              - id dolor est
              - deserunt nisi cupidatat
              snippet: quis
              historyId: ad
              internalDate: est pariatur offi
              payload:
                partId: mollit amet pariatur labore
                mimeType: in
                filename: aute
                headers:
                - name: consectetur dolor sint
                  value: anim
                - name: laborum est laboris molli
                  value: consequat est sint
                body:
                  attachmentId: aliquip ut cillum minim
                  size: 76634140
                  data: tempor
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: -35873513
              raw: irure qui laboris cupidatat
          - message:
              id: cupidatat do adipisicing
              threadId: occaecat pariatur
              labelIds:
              - sit et irure Exce
              - et Duis exercitation
              snippet: voluptate in
              historyId: ut esse
              internalDate: Excepteur consectetur aliqua nisi
              payload:
                partId: occaecat quis sunt
                mimeType: cillu
                filename: quis exercitation
                headers:
                - name: in proident el
                  value: nisi mollit sunt
                - name: o
                  value: consectetur proident in
                body:
                  attachmentId: sint incididunt fugiat velit sunt
                  size: -88355343
                  data: mollit commodo esse
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: 13437488
              raw: sed labore tempor
          labelsAdded:
          - message:
              id: cillum consequat eu laboris officia
              threadId: magna dolore
              labelIds:
              - sunt tempor officia deser
              - est irure in
              snippet: sint dolor sunt
              historyId: sunt do exercitation minim
              internalDate: ea voluptate Lorem enim
              payload:
                partId: sunt enim
                mimeType: id laboris
                filename: cupidatat
                headers:
                - name: tempor pariatur
                  value: cupidatat ex
                - name: in dolore quis
                  value: pariatur
                body:
                  attachmentId: 'aute '
                  size: 99676228
                  data: consequat veniam aliqua ex
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: 85599678
              raw: ut
            labelIds:
            - nisi eiusmod
            - et amet nisi sed laboris
          - message:
              id: enim
              threadId: Duis consectetur
              labelIds:
              - ullamco adi
              - sed
              snippet: nisi veniam
              historyId: ex
              internalDate: exercitation sit dolore
              payload:
                partId: officia
                mimeType: voluptate cillum officia et nostrud
                filename: dolore consequat laborum
                headers:
                - name: reprehenderit nostrud elit
                  value: consectetur in nisi
                - name: anim occaecat
                  value: occaecat laborum
                body:
                  attachmentId: dolore deserunt anim do minim
                  size: 83222280
                  data: enim magna
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: -97289468
              raw: dolore ea
            labelIds:
            - aliquip proident
            - mollit nostrud nisi elit
          labelsRemoved:
          - message:
              id: tempo
              threadId: in sunt esse nulla
              labelIds:
              - in dolor dolore ipsum
              - consequat irure ea
              snippet: enim anim eiusmod ipsum
              historyId: velit anim dolore fugiat
              internalDate: laboris
              payload:
                partId: reprehenderit ullamco
                mimeType: est consectetur et ullamco ad
                filename: anim laboris enim
                headers:
                - name: ea Lorem eiusmod
                  value: occaecat laborum in
                - name: Duis dolor ipsum au
                  value: cillum aliqua in
                body:
                  attachmentId: ''
                  size: -69821908
                  data: Ut amet ut
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: 30152194
              raw: enim minim ullamco aliqua cillum
            labelIds:
            - cillum
            - officia cillum sit
          - message:
              id: cillum reprehenderit Excepteur
              threadId: dolore esse sint culpa
              labelIds:
              - et irure eu do
              - elit et consectetur Ut
              snippet: ea s
              historyId: commodo veniam mollit qui ipsum
              internalDate: deserunt cupidatat mollit
              payload:
                partId: proident consectetur eu adipisicing
                mimeType: 'fugiat culpa aute '
                filename: aliquip sed
                headers:
                - name: anim dolor
                  value: consectetur
                - name: magna nostrud
                  value: consectetur enim culpa commodo
                body:
                  attachmentId: 'tempor sint '
                  size: 59632845
                  data: eu
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: 75124651
              raw: sed
            labelIds:
            - deserunt in aliqua cillum
            - anim in
        - id: ea consequat
          messages:
          - id: culpa enim
            threadId: ad commodo sed sunt Lorem
            labelIds:
            - cupidatat Duis
            - ut in quis cupidatat
            snippet: magna Lorem anim
            historyId: aliqua
            internalDate: velit id proident nostrud
            payload:
              partId: esse incididunt laboris deserunt eiusmod
              mimeType: ex sunt aliquip ut
              filename: incididunt qui
              headers:
              - name: nulla id
                value: nostrud anim
              - name: ipsum est anim consequat
                value: est eiusmod velit
              body:
                attachmentId: exercitation
                size: -2350523
                data: ut occaecat id
              parts:
              - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              - value: '<Circular reference to #/components/schemas/MessagePart detected>'
            sizeEstimate: -70931197
            raw: ex est commodo minim
          - id: dolore eu Lorem
            threadId: dolor
            labelIds:
            - non dolor Excepteur in
            - id nostrud irure amet
            snippet: n
            historyId: elit reprehenderit irure non
            internalDate: amet nostrud labore Excepte
            payload:
              partId: officia ut commodo
              mimeType: tempor occaecat
              filename: tempor
              headers:
              - name: cillum ullamco
                value: anim e
              - name: est exercitation irure e
                value: id
              body:
                attachmentId: incididunt culpa elit
                size: 99232191
                data: Excepteur ea pariatur culpa
              parts:
              - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              - value: '<Circular reference to #/components/schemas/MessagePart detected>'
            sizeEstimate: 76239793
            raw: nostrud reprehenderit velit
          messagesAdded:
          - message:
              id: ut mollit
              threadId: consequat ad
              labelIds:
              - nulla et qui
              - cupidatat aliquip commodo do
              snippet: nulla esse exercitation eiusmod
              historyId: tempor
              internalDate: non aliqua
              payload:
                partId: dolore quis elit
                mimeType: culpa id tempor ex
                filename: do Duis
                headers:
                - name: ut
                  value: tempor proident quis ut
                - name: aliqua
                  value: magna aliquip consequat eiusmod esse
                body:
                  attachmentId: cupidatat ullamco reprehenderit
                  size: 94308201
                  data: tempor deserunt sit amet
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: -17434830
              raw: velit in incididunt ad
          - message:
              id: labore ullamco
              threadId: magna nulla ut
              labelIds:
              - nulla sit eiusmod
              - labore an
              snippet: ex enim reprehenderit Ut
              historyId: ex
              internalDate: des
              payload:
                partId: incididunt et irure magna Duis
                mimeType: occaecat officia
                filename: ullamco culpa aute
                headers:
                - name: ex exercitation
                  value: commodo dolore ullamco
                - name: Excepteur
                  value: ipsum mag
                body:
                  attachmentId: et
                  size: -54386568
                  data: do ullamco
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: -10107583
              raw: sunt aute
          messagesDeleted:
          - message:
              id: p
              threadId: mollit elit
              labelIds:
              - con
              - ut proident ex
              snippet: minim cillum
              historyId: id enim E
              internalDate: ex
              payload:
                partId: quis ad
                mimeType: adipisicing est anim veniam
                filename: sit Ut
                headers:
                - name: ad id irure
                  value: ex est adipisicing
                - name: consectetur labore
                  value: elit enim
                body:
                  attachmentId: cillum non ut amet aliquip
                  size: 20140005
                  data: fugiat id exercitation
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: -77249420
              raw: Lorem tempor culpa
          - message:
              id: nostrud oc
              threadId: nostrud sed cillum velit sunt
              labelIds:
              - quis laboris laborum aliqua
              - dolor sed ut esse dolore
              snippet: non
              historyId: in consequat ipsum
              internalDate: ad ipsum dolore
              payload:
                partId: anim nulla nostrud incididunt ex
                mimeType: irure amet
                filename: ad
                headers:
                - name: veniam Excepteur sit ullamco
                  value: ullamco aute proident non
                - name: ut enim tempor
                  value: minim in cupidatat id
                body:
                  attachmentId: enim sit Duis in
                  size: -37124897
                  data: dolor Excepteur aute cupidatat dolor
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: 61813692
              raw: ipsum quis
          labelsAdded:
          - message:
              id: dolor mollit
              threadId: id ut veniam
              labelIds:
              - labore i
              - commodo Excepteur
              snippet: quis elit
              historyId: occaecat consequat amet aute fugiat
              internalDate: sed sunt
              payload:
                partId: occaecat deserunt sed ut
                mimeType: sunt ut ut voluptate
                filename: ipsum pariatur sed
                headers:
                - name: elit deserunt voluptate non
                  value: velit
                - name: consequat id eiusmod sed
                  value: veniam ut voluptate
                body:
                  attachmentId: ut ipsum laboris non et
                  size: -51157710
                  data: Excepteur voluptate
                parts:
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
                - value: '<Circular reference to #/components/schemas/MessagePart detected>'
              sizeEstimate: -83490524
              raw: sunt proident ut
            labelIds:
            - deserunt cillum
            - sit qui culpa irure
          - message:
              id: dolore pariatur
              threadId: est sit
              labelIds:
              - est dolore non aliqua
              - esse Duis proident
              snippet: culpa laboris
              historyId: exercitation do non
              in

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