Gong Settings API

openapi: 3.2.0
info:
  title: Gong Settings API
  description: 'Overview


    The Gong API allows you to:


    Receive the following information from Gong:


    Your company''s calls in Gong


    Your company''s users in Gong


    Your company''s user stats in Gong


    Your company''s user settings in Gong


    Your company''s libraries in Gong


    Upload new or

    update

    call recordings in Gong, in order to support cases where you have an internal system that records

    calls or obtains them from a third-party entity.


    Data Privacy:

    Delete users and all their associated elements.


    Upload CRM data into Gong.


    Check here what''s your base URL for all API calls.


    Authentication


    There are two ways to retrieve credentials to the Gong Public API:


    Retrieve Manually:


    In the Gong API Page (you

    must be a technical administrator in Gong), click "Create" to receive an Access Key

    and an Access Key Secret.


    Use the Basic Authorization HTTP header (as per RFC)

    to access the Public API as shown below:


    Authorization: Basic <token>


    To create the basic token, combine the Access Key and the Access Key Secret with

    colon (:) and then encode in Base64 as following:


    Base64(<accessKey> : <accessKeySecret>)


    Retrieve through OAuth


    To obtain the Bearer token, follow the steps described in the Gong OAuth Guide.


    After obtaining the token, use the Bearer Authorization HTTP header

    (as per RFC)

    to access the Public API as shown below:


    Authorization: Bearer <token>


    Limits


    By default Gong limits your company''s access to the service to 3 API calls per second, and 10,000 API calls per day.


    When the rate of API calls exceeds these limits an HTTP status code 429 is returned and a Retry-After header indicates

    how many seconds to wait before making a new request.


    If required, contact help.gong.io to change these limits.


    Cursors


    Some API calls that return a list are limited in the amount of records they may return, so multiple API calls may be

    required to bring all records. Such an API call also returns a records field, which contains the number of records

    in the current page, the current page number and the total number of records.


    In cases where the total number of records exceeds the number of records thus far retrieved, the records field will also

    contain a cursor field which can be used to access the next page of records. To retrieve the next page, repeat the API call with

    the cursor value as supplied by the previous API call. All other request inputs should remain the same.


    Forward Compatibility


    When coding a system to accept Gong data, take into account that Gong may, without prior warning, add fields to the JSON output.

    It is recommended to future proof your code so that it disregards all JSON fields you don''t actually use.'
  version: V2
servers:
- url: https://127.0.0.1:8443
  description: Generated server url
tags:
- name: Settings
  description: 'Gong’s “Settings” API endpoints allow you to:


    Request all the scorecards within the Gong system.


    Request all the workspaces including their details.'
paths:
  /v2/workspaces:
    get:
      tags:
      - Settings
      summary: List all company workspaces (/v2/workspaces)
      description: 'Returns a list of all workspaces including their details.


        When accessed through a Bearer token authorization method, this endpoint requires the scope ''api:workspaces:read''.'
      operationId: listWorkspaces
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspacesMetadata'
                exampleSetFlag: false
              exampleSetFlag: false
        '400':
          description: Malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '429':
          description: API request limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before making a new request.
              style: SIMPLE
              explode: false
              schema:
                type: integer
                format: int32
                exampleSetFlag: false
                types:
                - integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '500':
          description: Failed to complete the operation due to an unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
  /v2/settings/trackers:
    get:
      tags:
      - Settings
      summary: Retrieve tracker details (/v2/settings/trackers)
      description: 'Retrieves details of all keyword trackers in the system or in a given workspace.


        When accessed through a Bearer token authorization method, this endpoint requires the ''api:settings:trackers:read'' scope.'
      operationId: listTrackers
      parameters:
      - name: workspaceId
        in: query
        description: The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned.
        required: false
        style: FORM
        explode: true
        schema:
          type: string
          exampleSetFlag: false
          types:
          - string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Trackers'
                exampleSetFlag: false
              exampleSetFlag: false
        '400':
          description: Malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '429':
          description: API request limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before making a new request.
              style: SIMPLE
              explode: false
              schema:
                type: integer
                format: int32
                exampleSetFlag: false
                types:
                - integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '500':
          description: Failed to complete the operation due to an unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
  /v2/settings/scorecards:
    get:
      tags:
      - Settings
      summary: Retrieve scorecards details (/v2/settings/scorecards)
      description: 'Retrieve all the scorecards within the Gong system.


        When accessed through a Bearer token authorization method, this endpoint requires the scope ''api:settings:scorecards:read''.'
      operationId: listScorecards
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scorecards'
                exampleSetFlag: false
              exampleSetFlag: false
        '400':
          description: Malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '404':
          description: Scorecards not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '429':
          description: API request limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before making a new request.
              style: SIMPLE
              explode: false
              schema:
                type: integer
                format: int32
                exampleSetFlag: false
                types:
                - integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '500':
          description: Failed to complete the operation due to an unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
  /v2/settings/briefs:
    get:
      tags:
      - Settings
      summary: Retrieve AI brief settings (/v2/settings/briefs)
      description: 'Retrieves settings of all AI briefs in the system or in a specified workspace.


        Required authorization scope: ''api:ai-briefer:read''.'
      operationId: listBriefs
      parameters:
      - name: workspaceId
        in: query
        description: The ID of the workspace the AI briefs are in. When empty, all briefs in all workspaces are returned.
        required: false
        style: FORM
        explode: true
        schema:
          type: string
          exampleSetFlag: false
          types:
          - string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Briefs'
                exampleSetFlag: false
              exampleSetFlag: false
        '400':
          description: Malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '429':
          description: API request limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before making a new request.
              style: SIMPLE
              explode: false
              schema:
                type: integer
                format: int32
                exampleSetFlag: false
                types:
                - integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '500':
          description: Failed to complete the operation due to an unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
components:
  schemas:
    Scorecards:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        scorecards:
          type: array
          description: A list, in which each item contains one scorecard.
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/Scorecard'
            exampleSetFlag: false
          types:
          - array
      exampleSetFlag: false
      types:
      - object
    KeywordTracker:
      type: object
      properties:
        trackerId:
          type: string
          description: The unique identifier of the tracker.
          example: '6840000929075400007'
          exampleSetFlag: true
          types:
          - string
        trackerName:
          type: string
          description: The name of the tracker.
          example: Competitors
          exampleSetFlag: true
          types:
          - string
        workspaceId:
          type: string
          description: The id of the workspace the tracker is in.
          example: '623457276584334'
          exampleSetFlag: true
          types:
          - string
        languageKeywords:
          type: array
          description: The words and phrases defined for the tracker. Each languagueKeywords object contains the words and phrases defined in the specified language.
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/TrackerLanguageKeyword'
            exampleSetFlag: false
          types:
          - array
        affiliation:
          type: string
          description: 'Sets whether to track the keywords when said by people affiliated to a specific company. Options are: "Anyone", "Company", "NonCompany".'
          example: NonCompany
          exampleSetFlag: true
          types:
          - string
        partOfQuestion:
          type: boolean
          description: When true, only looks for the keywords when they are part of a question.
          example: false
          exampleSetFlag: true
          types:
          - boolean
        saidAt:
          type: string
          description: 'Sets whether the words and phrases are tracked at the beginning, end or anytime in a call. Options are: "Anytime", "First", or "Last". For “First” and “Last” see the saidAtInterval and saidAtUnit fields to see how long to track the keywords for.'
          example: Anytime
          exampleSetFlag: true
          types:
          - string
        saidAtInterval:
          type: integer
          description: Sets the period of time to check if the words or phrases came up in the call (according to the saidAt setting). This can be either minutes or percent depending on the value in the saidAtUnit parameter.
          format: int32
          exampleSetFlag: false
          types:
          - integer
        saidAtUnit:
          type: string
          description: Sets whether the time to look for keywords is in minutes or a percentage of the call duration (according to the saidAt setting).
          example: minutes
          exampleSetFlag: true
          types:
          - string
        saidInTopics:
          type: array
          description: Sets the topics in the call the tracker terms should be picked up in.
          exampleSetFlag: false
          items:
            type: string
            exampleSetFlag: false
            types:
            - string
          types:
          - array
        filterQuery:
          type: string
          description: 'A filter that defines which calls to include when searching for the keyword tracker. The filter is in JSON and is in the URL of the search page. Example: a filter for all outbound calls { "type": "And", "filters": [ { "type": "CallDirection", "terms": ["OUTBOUND"] } ] }'
          example: '{"type":"And","filters":[{"type":"CallDirection","terms":["OUTBOUND"]}]}'
          exampleSetFlag: true
          types:
          - string
        created:
          type: string
          description: 'Sets the date and time the tracker was created, in the ISO-8601 format, for example: ''2024-01-17T16:20:05-03:00'' or ''2016-02-16T03:57:04.834+05:30'' or ''2020-11-20T21:30:07.233692Z'', where Z stands for UTC.'
          example: '2018-02-17T02:30:00-08:00'
          exampleSetFlag: true
          types:
          - string
        creatorUserId:
          type: string
          description: The Id of the team member who created the tracker. Null when the tracker is built-in.
          example: '234599484848423'
          exampleSetFlag: true
          types:
          - string
        updated:
          type: string
          description: 'The date and time the tracker settings were last updated, in the ISO-8601 format, for example: ''2024-01-17T16:20:05-03:00'' or ''2016-02-16T03:57:04.834+05:30'' or ''2020-11-20T21:30:07.233692Z'', where Z stands for UTC.'
          example: '2018-02-17T02:30:00-08:00'
          exampleSetFlag: true
          types:
          - string
        updaterUserId:
          type: string
          description: The Id of the team member who updated the tracker. Null when the tracker is built-in.
          example: '234599484848423'
          exampleSetFlag: true
          types:
          - string
      description: The definition of a tracker.
      exampleSetFlag: false
      types:
      - object
    Brief:
      type: object
      properties:
        briefId:
          type: string
          description: The unique identifier of the brief.
          exampleSetFlag: false
          types:
          - string
        briefName:
          type: string
          description: The name of the brief.
          exampleSetFlag: false
          types:
          - string
        workspaceId:
          type: string
          description: The id of the workspace the brief is in.
          example: '623457276584334'
          exampleSetFlag: true
          types:
          - string
        description:
          type: string
          description: The description of the brief.
          exampleSetFlag: false
          types:
          - string
        status:
          type: string
          description: 'Indicates whether the brief is published. Options are: "Published", "Not published".'
          exampleSetFlag: false
          types:
          - string
        creator:
          type: string
          description: The name of the team member who created the brief.
          exampleSetFlag: false
          types:
          - string
        creatorUserId:
          type: string
          description: The id of the team member who created the brief.
          exampleSetFlag: false
          types:
          - string
        created:
          type: string
          description: 'The date and time the brief was created, in the ISO-8601 format, for example: ''2024-01-17T16:20:05-03:00'' or ''2016-02-16T03:57:04.834+05:30'' or ''2020-11-20T21:30:07.233692Z'', where Z stands for UTC.'
          example: '2018-02-17T02:30:00-08:00'
          exampleSetFlag: true
          types:
          - string
        updated:
          type: string
          description: 'The date and time the brief was last updated, in the ISO-8601 format, for example: ''2024-01-17T16:20:05-03:00'' or ''2016-02-16T03:57:04.834+05:30'' or ''2020-11-20T21:30:07.233692Z'', where Z stands for UTC.'
          example: '2018-02-17T02:30:00-08:00'
          exampleSetFlag: true
          types:
          - string
      description: AI Brief settings
      exampleSetFlag: false
      types:
      - object
    WorkspaceMetadata:
      type: object
      properties:
        id:
          type: string
          description: Gong's unique numeric identifier for the workspace (up to 20 digits).
          example: '623457276584334'
          exampleSetFlag: true
          types:
          - string
        name:
          type: string
          description: The name of the workspace.
          example: Some Workspace
          exampleSetFlag: true
          types:
          - string
        description:
          type: string
          description: The description of the workspace.
          example: This is one of our workspaces
          exampleSetFlag: true
          types:
          - string
      description: A list, in which each item provides a workspace metadata.
      exampleSetFlag: false
      types:
      - object
    Trackers:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        keywordTrackers:
          type: array
          description: A list of keyword trackers.
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/KeywordTracker'
            exampleSetFlag: false
          types:
          - array
      exampleSetFlag: false
      types:
      - object
    QuestionOption:
      type: object
      properties:
        id:
          type: integer
          description: The identifier of the option.
          format: int32
          example: 1
          exampleSetFlag: true
          types:
          - integer
        text:
          type: string
          description: The option’s text.
          example: The SDR did not mention the product
          exampleSetFlag: true
          types:
          - string
      description: The answer options in case of multi-select or single-select type question. Null otherwise.
      exampleSetFlag: false
      types:
      - object
    Scorecard:
      type: object
      properties:
        scorecardId:
          type: integer
          description: The identifier of the scorecard.
          format: int64
          example: 6843152929075440037
          exampleSetFlag: true
          types:
          - integer
        scorecardName:
          type: string
          description: Scorecard name.
          example: SDR Call Scorecard
          exampleSetFlag: true
          types:
          - string
        workspaceId:
          type: integer
          description: Scorecard workspaceId.
          format: int64
          example: 623457276584334
          exampleSetFlag: true
          types:
          - integer
        enabled:
          type: boolean
          description: If the scorecard is enabled or not.
          example: true
          exampleSetFlag: true
          types:
          - boolean
        updaterUserId:
          type: integer
          description: The user Id of the team member that updated the scorecard.
          format: int64
          example: 234599484848423
          exampleSetFlag: true
          types:
          - integer
        created:
          type: string
          description: 'The date and time when the scorecard was created in the ISO-8601 format, for example: ''2024-01-17T16:20:05-03:00'' or ''2016-02-16T03:57:04.834+05:30'' or ''2020-11-20T21:30:07.233692Z'', where Z stands for UTC.'
          format: date-time
          example: 1518863400.0
          exampleSetFlag: true
          types:
          - string
        updated:
          type: string
          description: 'The date and time when the scorecard was updated in the ISO-8601 format, for example: ''2024-01-17T16:20:05-03:00'' or ''2016-02-16T03:57:04.834+05:30'' or ''2020-11-20T21:30:07.233692Z'', where Z stands for UTC.'
          format: date-time
          example: 1519036200.0
          exampleSetFlag: true
          types:
          - string
        reviewMethod:
          type: string
          description: The method used to review the scorecard.
          exampleSetFlag: false
          types:
          - string
          enum:
          - AUTOMATIC
          - MANUAL
        questions:
          type: array
          description: The questions in the scorecard.
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/Question'
            exampleSetFlag: false
          types:
          - array
      description: A list, in which each item contains one scorecard.
      exampleSetFlag: false
      types:
      - object
    Briefs:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        briefs:
          type: array
          description: A list of AI briefs.
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/Brief'
            exampleSetFlag: false
          types:
          - array
      exampleSetFlag: false
      types:
      - object
    ErrorResponse:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        errors:
          type: array
          description: Error messages.
          example:
          - An error has occurred
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
            types:
            - string
          types:
          - array
      exampleSetFlag: false
      types:
      - object
    WorkspacesMetadata:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        workspaces:
          type: array
          description: A list, in which each item provides a workspace metadata.
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/WorkspaceMetadata'
            exampleSetFlag: false
          types:
          - array
      exampleSetFlag: false
      types:
      - object
    Question:
      type: object
      properties:
        questionId:
          type: integer
          description: The identifier for the question.
          format: int64
          exampleSetFlag: false
          types:
          - integer
        questionRevisionId:
          type: integer
          description: The identifier for the revision version of the question.
          format: int64
          example: 43955224753211112
          exampleSetFlag: true
          types:
          - integer
        questionText:
          type: string
          description: The question's text.
          example: How do you evaluate the SDR's overall performance in the call?
          exampleSetFlag: true
          types:
          - string
        isOverall:
          type: boolean
          description: If the question is the main overall question.
          example: false
          exampleSetFlag: true
          types:
          - boolean
        questionType:
          type: string
          description: The type of question.
          example: RANGE
          exampleSetFlag: true
          types:
          - string
        answerGuide:
          type: string
          description: The guide for answering the question.
          example: Answer is in the small talk
          exampleSetFlag: true
          types:
          - string
        minRange:
          type: integer
          description: The minimum value that can be selected in the answer. Null for questions with no range.
          format: int32
          example: 0
          exampleSetFlag: true
          types:
          - integer
        maxRange:
          type: integer
          description: The maximum value that can be selected in the answer. Null for questions with no range.
          format: int32
          example: 50
          exampleSetFlag: true
          types:
          - integer
        answerOptions:
          type: array
          description: The answer options in case of multi-select or single-select type question. Null otherwise.
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/QuestionOption'
            exampleSetFlag: false
          types:
          - array
      description: The questions in the scorecard.
      exampleSetFlag: false
      types:
      - object
    TrackerLanguageKeyword:
      type: object
      properties:
        language:
          type: string
          description: The ISO 639-2/B language code for the language the keywords are in. When set to "mul" (ISO 639-2/B code for multiple languages), the keywords are relevant for all languages.
          example: ukr
          exampleSetFlag: true
          types:
          - string
        keywords:
          type: array
          description: A list of words and phrases in the specified language.
          exampleSetFlag: false
          items:
            type: string
            exampleSetFlag: false
            types:
            - string
          types:
          - array
        includeRelatedForms:
          type: boolean
          description: When true the tracker identifies words in different forms, for example, if the keyword is "organize", "organized" and "organizes" are also included.
          example: false
          exampleSetFlag: true
          types:
          - boolean
      description: The tracker keywords definition.
      exampleSetFlag: false
      types:
      - object
x-provenance:
  method: harvested
  publisher: Gong
  source: https://app.gong.io/ajax/settings/api/documentation/specs?version=
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)