gong_api 1.0.0

data/gong-swagger.json

@@ -0,0 +1 @@
+{"swagger":"2.0","info":{"description":"<h2>Overview</h2>\n<p>\nThe Gong API allows you to:\n</p>\n<ol>\n<li>\nReceive the following information from Gong:\n<ol type=\"a\">\n<li>\nYour company's <a href=\"#tag--Calls\">calls</a> in Gong\n</li>\n<li>\nYour company's <a href=\"#tag--Users\">users</a> in Gong\n</li>\n<li>\nYour company's user <a href=\"#tag--Stats\">stats</a> in Gong\n</li>\n<li>\nYour company's user <a href=\"#tag--Settings\">settings</a> in Gong\n</li>\n<li>\nYour company's <a href=\"#tag--Library\">libraries</a> in Gong\n</li>\n</ol></li>\n<li>\n<a href=\"#post-/v2/calls\">Upload</a> new or \n<a href=\"#put-/v2/calls/-id-/media\">update</a> \ncall recordings in Gong, in order to support cases where you have an internal system that records \ncalls or obtains them from a third-party entity.\n</li>\n<li>\n<a href=\"#post-/v2/data-privacy/erase-data-for-email-address\">Data Privacy</a>: \nDelete users and all their associated elements.</li>\n<li>\nUpload <a href=\"#tag--CRM\">CRM</a> data into Gong. \n</li>\n</ol>\n<p>Base URL for all API calls is <a href=\"https://us-55616.api.gong.io\"> https://us-55616.api.gong.io </a>\n</p>\n<h2>Authentication</h2>\n\n<p>\nThere are two ways to retrieve credentials to the Gong Public API:\n</p>\n<ol><li>Retrieve Manually:<br>\n<p>\nIn the <a href=\"https://app.gong.io/company/api\">Gong API Page</a> (you\nmust be a technical administrator in Gong), click \"Create\" to receive an <b>Access Key</b>\n and an <b>Access Key Secret</b>.<br>\n</p>\n<p>\nUse the Basic Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc7617.txt\">RFC</a>)\nto access the Public API as shown below:<br>\n<code>Authorization: Basic &lt;token&gt;</code><br>\n</p>\n<p>\nTo create the basic token, combine the <b>Access Key</b> and the <b>Access Key Secret</b> with \ncolon (:) and then encode in Base64 as following:<br>\n<code>Base64(&lt;accessKey&gt; : &lt;accessKeySecret&gt;)</code><br><br>\n</p></li>\n<li>Retrieve through OAuth<br>\n<p>\nTo obtain the Bearer token, follow the steps described in the <a target=\"_blank\" href=\"https://help.gong.io/hc/en-us/articles/360056677792\">Gong OAuth Guide</a>.\n<br></p>\n<p>\nAfter obtaining the token, use the Bearer Authorization HTTP header\n(as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc6750.txt\">RFC</a>)\nto access the Public API as shown below:<br>\n<code>Authorization: Bearer &lt;token&gt;</code>\n</p>\n</li></ol>\n<h2>Limits</h2>\n\n<p>\nBy default Gong limits your company's access to the service to 3 API calls per second, and 10,000 API calls per day.\n</p>\n<p>\nWhen the rate of API calls exceeds these limits an HTTP status code <b>429</b> is returned and a <b>Retry-After</b> header indicates\n how many seconds to wait before making a new request.\n</p><p>\nIf required, contact help@gong.io to change these limits.\n</p>\n\n<h2>Cursors</h2>\n\n<p>\nSome API calls that return a list are limited in the amount of records they may return, so multiple API calls may be\n required to bring all records. Such an API call also returns a <b>records</b> field, which contains the number of records\n in the current page, the current page number and the total number of records.\n</p>\n<p>\nIn cases where the total number of records exceeds the number of records thus far retrieved, the <b>records</b> field will also\n contain a <b>cursor</b> field which can be used to access the next page of records. To retrieve the next page, repeat the API call with\n the <b>cursor</b> value as supplied by the previous API call. All other request inputs should remain the same.\n</p>\n<h2>Forward Compatibility</h2>\n\n<p>\nWhen coding a system to accept Gong data, take into account that Gong may, without prior warning, add fields to the JSON output.\n It is recommended to future proof your code so that it disregards all JSON fields you don't actually use.\n\n</p><p></p>","version":"V2","title":"Gong API"},"host":"127.0.0.1","basePath":"/","tags":[{"name":"Calls","description":"<h3>Gong’s “Calls” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest calls details from Gong\n</li>\n<li>\nUpload new calls to Gong\n</li>\n<li>\nUpdate Gong Calls with new media\n</li>\n</ul>\n<h3>The requested calls may contain the following call details:</h3>\n<ul>\n<li>\n<b>Meta Data</b> (Basic details such as call date, title, call URL, etc)\n</li>\n<li>\n<b>Parties</b> (A list of the call's participants)\n</li>\n<li>\n<b>Media</b> (The media urls of the call)\n</li>\n<li>\n<b>Content</b> (Analysis of the interaction content)\n<ul>\n<li>\nAction Items (A list of action items)\n</li>\n<li>\nStructure (A list of the agenda of each part of the call)\n</li>\n<li>\nTopics (A list of topics and their durations)\n</li>\n<li>\nTrackers (A list of trackers found in the call. Trackers are collections of phrases defined in Gong for this company)\n</li>\n<li>\nPhrases (A list of occurrence counters for each specific phrase within the tracker (e.g., Amazon, Walmart))\n</li>\n<li>\nContext (A list of links to external systems such as CRM, Dialer, Case Management, etc)\n</li>\n</ul>\n</li>\n<li>\n<b>Interaction</b> (Metrics collected around the interaction during the call)\n<ul>\n<li>\nInteraction Stats (A list of interaction statistics. Applicable values: 'Longest Monologue', \n'Longest Customer Story', 'Interactivity', 'Patience')\n</li>\n<li>\nQuestions (Question counts of the call)\n</li>\n<li>\nSpeakers (A list of the talk duration per speaker)\n</li>\n<li>\nVideo (A list of video statistics about what's presented and for how long)\n</li>\n</ul>\n</li>\n<li>\n<b>Collaboration</b> (Collaboration information added to the call)\n<ul>\n<li>\nPublic Comments (A list of public comments)\n</li>\n</ul>\n</li>\n<li>\n<b>Context</b> (A list of links to external systems such as CRM, Dialer, Case Management, etc)\n<ul>\n<li>\nObjects (List of objects within the external system)\n</li>\n<li>\nFields (Object fields)\n</li>\n</ul>\n</li>\n</ul>\n"},{"name":"Users","description":"<h3>Gong’s “Users” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest a list of all the company's users with details\n</li>\n<li>\nRequest a specific user’s history from Gong\n</li>\n</ul>\n<h3>The requested users may contain the following details:</h3>\n<ul>\n<li>\nIf the Gong user is active or not.\n</li>\n<li>\nCreation time of the Gong user.\n</li>\n<li>\nThe email address of the Gong user.\n</li>\n<li>\nList of email address aliases of the Gong user.\n</li>\n<li>\nThe extension number of the Gong user.\n</li>\n<li>\nThe first name of the Gong user.\n</li>\n<li>\nThe last name of the Gong user.\n</li>\n<li>\nGong's unique numeric identifier for the user.\n</li>\n<li>\nThe manager ID of the Gong user.\n</li>\n<li>\nThe Gong recording consent meeting link.\n</li>\n<li>\nThe list of personal meeting URLs of the Gong user.\n</li>\n<li>\nThe phone number of the Gong user.\n</li>\n<li>\nThe job title of the Gong user.\n</li>\n<li>\nThe user's settings.\n<ul>\n<li>\nIf the team member is set to import emails by Gong.\n</li>\n<li>\nIf the team member is set to prevent import of emails by Gong.\n</li>\n<li>\nIf the invitation of this user to a web conference will prevent its recording (even if other users invited are set to record).\n</li>\n<li>\nIf the team member is set to import telephony calls by Gong.\n</li>\n<li>\nIf the team member is set to be recorded by Gong.\n</li>\n</ul>\n</li>\n<li>\nThe User's settings history.\n<ul>\n<li>\nThe user capability that was changed.\n</li>\n<li>\nThe date and time the action was set.\n</li>\n<li>\nThe new value that was set.\n</li>\n</ul>\n</li>\n</ul>\n"},{"name":"Stats","description":"<h3>Gong’s “Stats” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest user activity\n</li>\n<li>\nRequest scorecards activity\n</li>\n<li>\nRequest interaction stats on calls that have Whisper turned on\n</li>\n</ul>\n<h3>The requested user activity may contain the following details:</h3>\n<ul>\n<li>\n<b>Calls Hosted:</b> The number of recorded calls this user hosted.\n</li>\n<li>\n<b>Call Participated:</b> The number of calls in which this user is a participant (not host).\n</li>\n<li>\n<b>Calls Reviewed:</b> The number of calls in which someone pressed the \"Mark as reviewed\".\n</li>\n<li>\n<b>Calls Listened:</b> The number of other users' calls the user listened to.\n</li>\n<li>\n<b>Call Shared Outside:</b> The number of calls the user shared with others outside the company.\n</li>\n<li>\n<b>Call Shared Inside:</b> The number of calls the user shared with others inside the company.\n</li>\n<li>\n<b>Own Calls Listened:</b> The number of the user's own calls the user listened to.\n</li>\n<li>\n<b>Comment Given:</b> The number of calls in which a user gave at least one comment.\n</li>\n<li>\n<b>Comment Received:</b> The number of calls in which a user received at least one comment on the users calls.\n</li>\n<li>\n<b>Feedback Given:</b> The number of recorded calls the user gave feedback on.\n</li>\n<li>\n<b>Feedback Received:</b> The number of recorded calls the user received feedback on.\n</li>\n<li>\n<b>Feedback Requested:</b> The number of recorded calls the user requested feedback on.\n</li>\n<li>\n<b>Scorecard Filled:</b> The number of calls in which someone filled a scorecard on the user's calls.\n</li>\n<li>\n<b>Scorecards Completed:</b> The number of scorecards the user completed.\n</li>\n<li>\n<b>Scorecards Answers:</b> The answers in the answered scorecard.\n</li>\n<li>\n<b>Whisper:</b> Person Interaction Stats (List of user interaction stats. Applicable values: 'Talk Ratio',\n 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Question Rate', 'Patience').\n</li>\n</ul>\n"},{"name":"Settings","description":"<h3>Gong’s “Settings” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest all the scorecards within the Gong system.\n</li>\n<li>\nRequest all the workspaces including their details.\n</li>\n</ul>\n"},{"name":"Data Privacy","description":"<h3>Gong’s “Data Privacy” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest all references to an email address.\n</li>\n<li>\nRequest all references to a phone number.\n</li>\n<li>\nDelete the email address, and all associated elements.\n</li>\n<li>\nDelete the phone number, and all associated elements.\n</li>\n</ul>\n"},{"name":"Library","description":"<h3>Gong’s “Library” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest all the calls in a specific folder.\n</li>\n<li>\nRequest all the Library folders. We do not allow retrieval of either private or archived folders.\n</li>\n</ul>\n"},{"name":"CRM","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p><span class='public-api-info'><b>Limited Availability</b> - contact your CSM for information.</span></p><p>The Gong CRM API enables CRMs that are not natively integrated with Gong to work with Gong. Upload your CRMs data to enable Gong to leverage your CRM data as part of its Revenue Intelligence solution.</p><h2>Overview</h2><p>The CRM API enables Gong customers to upload their data to Gong as well as keep that data up to date - meaning changes to the CRM data are uploaded to Gong. Gong will associate communications (calls, emails, etc.) with the related CRM objects (e.g., Deals, Accounts, Contacts, Leads).</p><br>There are two kinds of upload:<ul>   <li>initial upload</li>   <li>incremental upload</li></ul><h3>Initial upload</h3><p>Performed the first time the CRM connects to Gong.</p><ul>    <li>All relevant objects are uploaded to Gong including the relevant data fields.</li></ul><h3>Incremental upload</h3><p>After the initial upload has been completed, you should send regular incremental data updates to Gong.</p><ul>    <li>The CRM only uploads objects that were changed since the previous incremental upload.</li>    <li>During an incremental upload:        <ul>            <li>Objects that already exist in Gong are updated.</li>            <li>Objects that did not exist are created.</li>        </ul>    </li></ul><ul class='public-api-info'>    <li>Initial upload and incremental upload use the same upload API.</li>    <li>Each uploaded object is identified by an ID. The object ID is a mandatory string and unique per object type.</li>    <li>The same object should always be sent with the same ID.</li>    <li>IDs are also used to link between objects. For example, a deal object has an ownerId field which is the object ID of the user that owns that deal.</li></ul><h2>Recommendations</h2><div><ul>   <li>Update Gong CRM data every 1-15 minutes.<br>       This ensures Gong stores the most recent data, which improves the user experience.   </li>    <li><b>To view and filter:</b> Send files to Gong, and filter the data in Gong Reports etc.</li>    <li><b>To list mandatory fields:</b> Refer to \"/object/entities\" API (the Common CRM Object Fields section, and the list of fields for the four object types: Account, Contact, Deal and Lead).</li></ul></div><h2>The API Protocol</h2><p>The API protocol is based on REST guidelines whose endpoints start with https://api.gong.io/<b>v2/crm</b>.<br>e.g: https://api.gong.io/v2/crm/integration/new.</p><p>The payload is either a JSON object or, for API calls that upload lists of objects, line delimited JSON (see: <a href='https://en.wikipedia.org/wiki/JSON_streaming#Line-delimited_JSON' target='_blank'>JSON streaming</a>). <br>JSON objects should be UTF-8 encoded.</p><p>Each API call must include a Basic Authorization header as defined in the <a href='https://app.gong.io/settings/api/documentation#overview' target='_blank'>Authentication section</a>.</p><h2>Upload CRM Data to Gong</h2><h3>Supported CRM Objects</h3><p>The API supports these object types: Contact, Account, Deal, and Lead.</p><p>The following relationship between entities must exist*:</p><ol>    <li>A <b>deal</b> must be linked to a single <b>account</b>.</li>    <li>A <b>contact</b> must be linked to a single <b>account</b>.</li>    <li>A <b>deal</b> must have an owner who is a <b>user</b> in Gong.</li>    <li>A <b>converted lead</b> is expected to be converted into an <b>account</b> and/or a <b>deal</b> and/or a <b>contact</b>.</li></ol><p>* If your object hierarchy is different, contact Gong Support.</p><h2>Successful Integration Best Practices</h2><div><br>At the first deployment:<ul>    <li>Send all the CRM data in your system except for deleted entities.</li></ul>After the first deployment:<ul>    <li>Send changes (including deleted entities) every 1-15 minutes.</li></ul>Update Gong regularly:<ul>    <li>Gong monitors the liveliness of the integration, so send empty lists even if no changes occurred from the previous time.</li></ul></div><h2>Getting Started</h2><p>The following steps will guide you through creating a successful integration:</p><ol>    <li>Generate an API Key via Gong API Main Page, then create Base64 Token from the provided Access Key and Access Key Secret as explained in <a href='https://app.gong.io/settings/api/documentation#overview' target='_blank'>Authentication</a>. The Base64 Token must be set in the \"Authorization\" header of every API call.</li>    <li>Call the <a href='https://app.gong.io/settings/api/documentation#put-/v2/crm/integration/new' target='_blank'>Register a Generic CRM integration API</a> to create a new integration in Gong with your CRM. The received \"integrationId\" is required for every subsequent API call.</li>    <li>Create users via the Team Members Page. Each user <b>must be set</b> to \"Record web conferences\" or \"Import calls\".</li>    <li>Upload users via the <a href='https://app.gong.io/settings/api/documentation#post-/v2/crm/object/entities' target='_blank'>Upload CRM objects API</a> (/v2/crm/object/entities?objectType=BUSINESS_USER) to map between users from your CRM and the users you created in Gong. The mapping is based on the user's email address.</li>    <li>Call the <a href='https://app.gong.io/settings/api/documentation#post-/v2/crm/object/schema' target='_blank'>Upload Object Schema API</a> to upload schema of any additional field that you want to send when uploading CRM objects. An additional field is any field which is not defined in the <a href='https://app.gong.io/settings/api/documentation#post-/v2/crm/object/entities' target='_blank'>Upload CRM objects API</a>.<br>    If you are not going to send additional fields, you can skip this step.    </li>    <li>Call the <a href='https://app.gong.io/settings/api/documentation#post-/v2/crm/object/entities' target='_blank'>Upload CRM objects API</a> (/v2/crm/object/entities?objectType=STAGE) to upload a list of all available stages from your CRM.</li>    <li>Call the <a href='https://app.gong.io/settings/api/documentation#post-/v2/crm/object/entities' target='_blank'>Upload CRM objects API</a> to upload CRM objects into Gong in the following order: Account, Contact, Deal, Lead. The order is important for correct processing of the CRM objects in Gong, since there are dependencies between the objects. For example, a Contact is linked to an Account via the \"accountId\" field.</li>    <li>Call the <a href='https://app.gong.io/settings/api/documentation#get-/v2/crm/request-status' target='_blank'>Get Request Status API</a> to follow the status of the upload objects request and verify there are no errors. A status of <span class='public-api-info'>DONE</span> indicates that there are no parsing errors such as missing mandatory fields, malformed dates, etc. and that the uploaded objects stored successfully in Raw Storage.</li>    <li>Call the <a href='https://app.gong.io/settings/api/documentation#get-/v2/crm/object/list' target='_blank'>Get CRM objects API</a> to verify that the uploaded objects were successfully processed from Raw Storage into Gong's Main Database. Note that it can take up to 30 minutes from uploading the objects until they are available in Gong's Main Database.</li></ol><br><br><br><br>"},{"name":"Engagement (in Beta Phase)","description":"<h3>Limited release - contact <a href=\"mailto:integration.requests@gong.io\">integration.requests@gong.io</a> for more information.\n</h3>\n\n<h3>Gong’s \"Engagement\" API endpoints allow you to push engagement events into Gong and display them as events in Gong’s activity timeline.</h3>\n<h3>There are currently 3 types of events:</h3>\n<ul>\n<li>\n\"Content Shared\" Event Type - Use this event type to push engagement events into Gong when a Gong user shares content with external participants (for example, a contract was “shared” by the account executive with his prospects)</li>\n<li>\n\"Content Viewed\" Event Type - Use this event type to push engagement events into Gong when a content is viewed by an external participant (for example, a contract was “viewed” by the prospect)\n</li>\n<li>\n\"Custom Action\" Event Type -  Use this event type to push engagement events into Gong when a content is engaged by an external participant (for example, a contract was “signed” by the prospect)</li>\n</ul>\n"},{"name":"Auditing","description":"<h3>Gong’s “Auditing” API endpoints allow you to request the following log types from Gong:</h3>\n<ul>\n<li>\nAccess Log - This log is preserved for 14 days only\n</li>\n<li>\nUser Activity Log - The data is available since March 2021\n</li>\n<li>\nUser Call Play Log - All data is available since inception\n</li>\n<li>\nExternally Shared Call Access Log - All data is available since inception\n</li>\n<li>\nExternally Shared Call Play Log - All data is available since inception\n</li>\n</ul>\n"},{"name":"Meetings (in Beta Phase)","description":"<h3>Gong’s “Consent Meeting” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest creating a Gong Consent meeting link\n</li>\n<li>\nUpdate a Consent Meeting’s details\n</li>\n<li>\nDelete a Consent Meeting\n</li>\n<li>\nList all Licensed Users in the Gong instance and their Consent Page status\n</li>\n</ul>\n<h3>The requested calls may contain the following meeting details:</h3>\n<ul>\n<li>\nMeeting Scheduled Start Time\n</li>\n<li>\nMeeting Scheduled End Time\n</li>\n<li>\nOrganizer\n</li>\n<li>\nMeeting Title\n</li>\n<li>\nInvitees\n</li>\n<li>\nExternal Meeting Id - The ID as it is formed on an external system\n</li>\n</ul>\n"},{"name":"Permissions","description":"<h3>Gong’s \"Permission\" API endpoints allow you to:</h3>\n<ul>\n<li>\nList all permission profiles in a given workspace\n</li>\n<li>\nCreate permission profile\n</li>\n<li>\nGet a permission profile\n</li>\n<li>\nUpdate permission profile\n</li>\n<li>\nList all users controlled by a permission profile\n</li>\n<li>\nAllow users individual access to calls\n</li>\n<li>\nRemove user's individual access to calls\n</li>\n<li>\nRetrieve users that have individual access to calls\n</li>\n</ul>\n"}],"paths":{"/v2/calls":{"get":{"tags":["Calls"],"summary":"Retrieve call data by date range (/v2/calls)","description":"List calls that took place during a specified date range.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.","operationId":"listCallsUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records.","required":false,"type":"string","x-example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM"},{"name":"fromDateTime","in":"query","description":"The date from which to list calls, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the calls start with the earliest recorded call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.","required":true,"type":"string"},{"name":"toDateTime","in":"query","description":"The date until which to list calls, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the calls end with the latest recorded call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.","required":true,"type":"string"},{"name":"workspaceId","in":"query","description":"Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.","required":false,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/CallsResponse","originalRef":"#/definitions/CallsResponse"},"schema":{"$ref":"#/definitions/CallsResponse","originalRef":"#/definitions/CallsResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No calls found for the specified period","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}},"post":{"tags":["Calls"],"summary":"Add new call (/v2/calls)","description":"When using this endpoint, either provide a downloadMediaUrl or use the returned callId in a follow-up request to /v2/calls/{id}/media to upload the media file.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.","operationId":"addCallUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"newCallAddingRequest","description":"newCallAddingRequest","required":true,"schema":{"$ref":"#/definitions/NewCallAddingRequest","originalRef":"#/definitions/NewCallAddingRequest"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/NewCallAddingResponse","originalRef":"#/definitions/NewCallAddingResponse"},"schema":{"$ref":"#/definitions/NewCallAddingResponse","originalRef":"#/definitions/NewCallAddingResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict, e.g. recording is not enabled for the primary user","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/calls/{id}/media":{"put":{"tags":["Calls"],"summary":"Add call media (/v2/calls/{id}/media)","description":"Adds a call media, recorded by a telephony system (PBX) or other media recording facility. Gong accepts call recordings in various audio and video file formats, including WAV, MP3, MP4, MKV and FLAC. If uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel correspondsto the company team member (rep) in the parties/mediaChannelId parameter of the Add New Call operation.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.","operationId":"addCallRecordingUsingPUT","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"mediaFile","in":"formData","required":false,"type":"file"},{"name":"id","in":"path","description":"callId returned from 'Add New Call' request","required":true,"type":"string"}],"responses":{"201":{"description":"Successfully registered the new call recording","responseSchema":{"$ref":"#/definitions/NewCallRecordingResponse","originalRef":"#/definitions/NewCallRecordingResponse"},"schema":{"$ref":"#/definitions/NewCallRecordingResponse","originalRef":"#/definitions/NewCallRecordingResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/calls/{id}":{"get":{"tags":["Calls"],"summary":"Retrieve data for a specific call (/v2/calls/{id})","description":"Retrieve data for a specific call.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.","operationId":"getCallUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Gong's unique numeric identifier for the call (up to 20 digits).","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/SpecificCall","originalRef":"#/definitions/SpecificCall"},"schema":{"$ref":"#/definitions/SpecificCall","originalRef":"#/definitions/SpecificCall"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"Call ID was not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/calls/extensive":{"post":{"tags":["Calls"],"summary":"Retrieve detailed call data by various filters (/v2/calls/extensive)","description":"Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:extensive'. \nMoreover, clients requesting media download URLs by the contentSelector.exposedFields.media field should also have the scope 'api:calls:read:media-url'.","operationId":"listCallsExtensiveUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"callsRequest","description":"callsRequest","required":true,"schema":{"$ref":"#/definitions/Request«CallsRequestFilterWithOwners,ContentSelector»","originalRef":"#/definitions/Request«CallsRequestFilterWithOwners,ContentSelector»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/Calls","originalRef":"#/definitions/Calls"},"schema":{"$ref":"#/definitions/Calls","originalRef":"#/definitions/Calls"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No calls found for the specified period","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/all-permission-profiles":{"get":{"tags":["Permissions"],"summary":"List all company permission profiles for a given workspace (/v2/all-permission-profiles)","description":"Returns a list of all permission profiles.\n\nThe listing is in the alphabetical order of the profile names.","operationId":"listPermissionProfileUsingGET","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace identifier, the API will return only the profiles belonging to this workspace.\n\nYou can retrieve the workspace using the \"workspaces\" (under \"Settings\") API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/PermissionProfilesResponse","originalRef":"#/definitions/PermissionProfilesResponse"},"schema":{"$ref":"#/definitions/PermissionProfilesResponse","originalRef":"#/definitions/PermissionProfilesResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/calls/manual-crm-associations":{"get":{"tags":["Calls"],"summary":"List all calls that were manually associated with CRM objects (/v2/calls/manual-crm-associations) in Beta Phase","description":"Returns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time.\n\nActions will be listed in the ascending order of their timing. \n\nNotice if a call was associated and later re-associated the API will return both events.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:crm-calls:manual-association:read'.","operationId":"listCRMCallsManualAssociationUsingGET","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records.","required":false,"type":"string","x-example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM"},{"name":"fromDateTime","in":"query","description":"Association time filter - only the associations made after that time will be listed. The time is in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified all association events will be listed.","required":false,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/ManualAssociationResponse","originalRef":"#/definitions/ManualAssociationResponse"},"schema":{"$ref":"#/definitions/ManualAssociationResponse","originalRef":"#/definitions/ManualAssociationResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/calls/transcript":{"post":{"tags":["Calls"],"summary":"Retrieve transcripts of calls by date or callIds (/v2/calls/transcript)","description":"Lists the transcripts of calls that took place during a specified date range and have specified callIds.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:transcript'.","operationId":"getCallTranscriptsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"callsRequest","description":"callsRequest","required":true,"schema":{"$ref":"#/definitions/Request«CallsFilter»","originalRef":"#/definitions/Request«CallsFilter»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/CallTranscripts","originalRef":"#/definitions/CallTranscripts"},"schema":{"$ref":"#/definitions/CallTranscripts","originalRef":"#/definitions/CallTranscripts"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No calls found for the specified period","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/calls/users-access":{"get":{"tags":["Permissions"],"summary":"Retrieve users that have specific individual access to calls (/v2/calls/users-access)","description":"Returns a list of users who have received individual access to calls through the API.\n\nThis endpoint doesn't cover user that have access for other reasons (such as sharing recipients, or access through permission profiles).\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:read'.","operationId":"getUsersAccessToCallsUsingGET","produces":["application/json"],"parameters":[{"in":"body","name":"callsAccessGetDto","description":"callsAccessGetDto","required":true,"schema":{"$ref":"#/definitions/Request«CallsAccessGetDto»","originalRef":"#/definitions/Request«CallsAccessGetDto»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/CallsAccessDetailsResponse","originalRef":"#/definitions/CallsAccessDetailsResponse"},"schema":{"$ref":"#/definitions/CallsAccessDetailsResponse","originalRef":"#/definitions/CallsAccessDetailsResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}},"put":{"tags":["Permissions"],"summary":"Give individual users access to calls (/v2/calls/users-access)","description":"Give individual users access to calls.\n\nIf a user already has access (perhaps the call was shared with them, or they have access through their permission profiles) the request will have no effect.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.","operationId":"addUsersAccessToCallsUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"callsUsersAccessAddDto","description":"callsUsersAccessAddDto","required":true,"schema":{"$ref":"#/definitions/CallsUsersAccessAddDto","originalRef":"#/definitions/CallsUsersAccessAddDto"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"},"schema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}},"delete":{"tags":["Permissions"],"summary":"Remove specific individual users access from calls (/v2/calls/users-access)","description":"Remove individual user access from calls. The request can only remove access previously given by the /v2/calls/users-access API.\n\nIf a given user does not have access to the call, they will be unaffected.\n\nIf a given user does have access to the call, but not through the pubic API (for example if the call was shared with the user), the user's access will remain unchanged.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.","operationId":"deleteUsersAccessToCallsUsingDELETE","produces":["application/json"],"parameters":[{"in":"body","name":"callsUsersAccessDeleteDto","description":"callsUsersAccessDeleteDto","required":true,"schema":{"$ref":"#/definitions/CallsUsersAccessDeleteDto","originalRef":"#/definitions/CallsUsersAccessDeleteDto"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"},"schema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/integration/delete":{"delete":{"tags":["CRM"],"summary":"Delete a Generic CRM integration (/v2/crm/integration/delete)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>Deletes a Generic CRM integration and all its associated crm objects (Accounts, Contacts, Deals, Leads, and Users).</p><p>This API is asynchronous. Call \"/request-status\" API with the clientRequestId sent to this API to track progress of the delete request:<br>Status DONE indicates that the integration and all its associated crm objects have been successfully deleted. Calls associations may take up to 24 hours to be deleted.</p><h3>Example</h3><h4>Request</h4><code>DELETE https://api.gong.io/v2/crm/integration/delete?clientRequestId=1234&integrationId=6286478263646</code><p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:integration:delete'.</p>","operationId":"deleteGenericCrmIntegrationUsingDELETE","produces":["application/json"],"parameters":[{"name":"clientRequestId","in":"query","description":"A unique identifier sent by you to allow troubleshooting requests. Valid characters for this field are letters, numbers, dashes and underscores.","required":true,"type":"string"},{"name":"integrationId","in":"query","description":"Integration ID generated when creating the integration","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","responseSchema":{"$ref":"#/definitions/AsyncProcessingResponse","originalRef":"#/definitions/AsyncProcessingResponse"},"schema":{"$ref":"#/definitions/AsyncProcessingResponse","originalRef":"#/definitions/AsyncProcessingResponse"}},"201":{"description":"Successfully registered the delete integration request","responseSchema":{"$ref":"#/definitions/AsyncProcessingResponse","originalRef":"#/definitions/AsyncProcessingResponse"},"schema":{"$ref":"#/definitions/AsyncProcessingResponse","originalRef":"#/definitions/AsyncProcessingResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"409":{"description":"Client request id has already been used","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/integration/list":{"get":{"tags":["CRM"],"summary":"Get Generic CRM integration details (/v2/crm/integration/list)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>Returns a list of all active Generic CRM integrations of the company. Only integrations created with 'Register a Generic CRM integration' API are returned.<br>Only one active integration is currently supported.</p><p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:integrations:read'.</p>","operationId":"listGenericCrmIntegrationUsingGET","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/ListGenericCrmIntegrationsResponse","originalRef":"#/definitions/ListGenericCrmIntegrationsResponse"},"schema":{"$ref":"#/definitions/ListGenericCrmIntegrationsResponse","originalRef":"#/definitions/ListGenericCrmIntegrationsResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/integration/new":{"put":{"tags":["CRM"],"summary":"Register a Generic CRM integration (/v2/crm/integration/new)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>Register the CRM application in Gong and use the returned integrationId in future requests to the CRM API to correlate the data with the specific CRM.</p><p>Multiple CRM integrations are not currently supported. To create a new integration, first delete the old one.</p><p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:integration:register'.</p>","operationId":"registerGenericCrmIntegrationUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"registrationRequest","description":"registrationRequest","required":true,"schema":{"$ref":"#/definitions/GenericCrmRegistrationRequest","originalRef":"#/definitions/GenericCrmRegistrationRequest"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/RegisterGenericCrmResponse","originalRef":"#/definitions/RegisterGenericCrmResponse"},"schema":{"$ref":"#/definitions/RegisterGenericCrmResponse","originalRef":"#/definitions/RegisterGenericCrmResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict - An active integration already exists.","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/map/users":{"post":{"tags":["CRM"],"summary":"Map Users (Deprecated)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>This API is <b>Deprecated</b>. Please use \"/object/entities?objectType=BUSINESS_USER\" API instead.</p><p>Gong associates users with the CRM <b>User</b> entity. Mapping users accurately is essential for Gong to connect users with all their associated objects in the CRM.</p><p>This API creates a mapping in Gong between the user ID in the CRM system and the user ID in Gong.</p><br><div class='public-api-important'><b>Important:</b><p>User mapping is important to ensure deals are processed in Gong correctly. Each uploaded deal contains an ownerId field, which contains a user ID from the CRM system.<br><b>Gong only processes a deal if this user ID is mapped to a user in Gong who is set to record or import calls.</b></p><p>Each request to this API must include the complete list of users from the CRM system.</p></div><p>If a user mapping is sent after a deal is uploaded:</p><ol>    <li>Gong retroactively searches for deals whose ownerId matches the user ID mapping.</li>    <li>Gong starts to reprocess those matched deals from raw storage into Gong’s main database.</li></ol><p>Gong matches the user from the uploaded JSON to a user in Gong based on the email address.</p><div class='public-api-info'><p>The user mapping will not be created when:</p><ul>    <li>There is no user in Gong with the supplied email address</li>    <li>Mapping already exists for the supplied email address</li></ul></div><p>To update an existing mapping:</p><ol>    <li>Delete the existing mapping by sending an existing mapping with isDeleted=true.</li>    <li>In a separate request send a new mapping for the email address.</li></ol><p>The request body is a file in LDJSON format, meaning the file should contain JSON objects - where each JSON object is on a separate line and represents a single user from the CRM system.</p><p><b>Request Body Specifications:</b></p><ul>    <li>Content-Type should be multipart/form-data</li>    <li>Maximum payload size: 200 megabytes</li>    <li>The request body should include one parameter named \"<b>dataFile</b>\" which contains the LDJSON file.</li></ul><h3>Request parameters (QUERY-STRING parameters)</h3><table>    <thead>        <tr>            <th>Name</th>            <th>Description</th>            <th>Data Type</th>            <th>Mandatory</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>clientRequestId</span></td>            <td>A unique identifier sent by you to enable troubleshooting communication.<br>            Gong uses this identifier to prevent repeated attempts to upload the same users list.<br>            Valid characters for this field: Letters, numbers, dashes, and underscores.            </td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>integrationId</span></td>            <td>Integration ID generated when creating the integration</td>            <td>long</td>            <td>Y</td>        </tr>    </tbody></table><p>User JSON object requires the following fields:</p><table>    <thead>        <tr>            <th>Name</th>            <th>Description</th>            <th>Data Type</th>            <th>Mandatory</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>crmUserId</span></td>            <td>User ID in the CRM system</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>emailAddress</span></td>            <td>Must match an email address of a user in Gong. Not mandatory when isDeleted = true.</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>isDeleted</span></td>            <td>\"true\" deletes the user mapping. Default = \"false\"</td>            <td>boolean</td>            <td>N</td>        </tr>    </tbody></table><h3>Response</h3><code>201 Created</code><table>    <thead>        <tr>            <th>Name</th>            <th>Data Type</th>            <th>Description</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>clientRequestId</span></td>            <td>string</td>            <td>the <span class='public-api-parameter'>clientRequestId</span> sent in the request</td>        </tr>        <tr>            <td><span class='public-api-parameter'>requestId</span></td>            <td>string</td>            <td>A Gong request reference Id, generated for this request</td>        </tr>    </tbody></table><div class='public-api-important'><p><b>Important:</b> The users mapping API is asynchronous. A 201 response only indicates that the file successfully uploaded to Gong and is pending processing. Use the <span class='public-api-parameter'>clientRequestId</span> to troubleshoot failed requests and watch the request status using \"/request-status\" API.</p></div><h3>Error Codes</h3>400 - Malformed request<br>401 - Access denied<br>409 Conflict - clientRequestId already exists<br>429 - API request limit exceeded<br>500 - Internal Server Error<p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:upload'.</p><h3>Example</h3><h4>Request</h4><code>POST https://api.gong.io/v2/crm/map/users?clientRequestId=1234&integrationId=6286478263646</code><br><br><code>{\"crmUserId\": \"2356ddfwe32\", \"emailAddress\": \"john.doe@acme.com\"}<br>{\"crmUserId\": \"67534ghf745\", \"isDeleted\": true} // remove user mapping for user 67534ghf745</code>","operationId":"mapCrmUsersUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"dataFile","in":"formData","required":false,"type":"file"}],"responses":{"201":{"description":"Successfully registered the new crm users data","responseSchema":{"$ref":"#/definitions/AsyncProcessingResponse","originalRef":"#/definitions/AsyncProcessingResponse"},"schema":{"$ref":"#/definitions/AsyncProcessingResponse","originalRef":"#/definitions/AsyncProcessingResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"409":{"description":"Client request id has already been used","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/object/entities":{"post":{"tags":["CRM"],"summary":"Upload CRM objects (/v2/crm/object/entities)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>Inserts, updates, or deletes a CRM object in Gong.<br>If an existing object with the same id is detected it will be updated, otherwise it will be inserted as a new object.</p><p>The request body is a file in LDJSON format, meaning the file should contain JSON objects, where each JSON object is in a separate line and represents a single CRM object.</p><p>All objects in a single request should be of the same object type. An object cannot be contained more than once in a given list.</p><p><b>Request Body Specifications:</b></p><ul>    <li>Content-Type should be multipart/form-data</li>    <li>Maximum payload size: 200 megabytes</li>    <li>The request body should contain one parameter named \"<b>dataFile</b>\" which holds the LDJSON file</li></ul><div class='public-api-important'><p><b>Important:</b> The list must be sorted by modifiedDate Ascending.</p></div><div class='public-api-info'><p><ul>    <li>On initial upload: Only send the items that weren’t deleted</li>    <li>On subsequent (incremental) uploads: Send all items.</li></ul></p></div><div class='public-api-info'><p>Dates in the uploaded JSON objects are represented in ISO-8601 format without milliseconds (e.g. '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).</p></div><h3>Request parameters (QUERY-STRING parameters)</h3><table>    <thead>        <tr>            <th>Name</th>            <th>Description</th>            <th>Data Type</th>            <th>Mandatory</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>integrationId</span></td>            <td>Integration ID generated when creating the integration</td>            <td>long</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>objectType</span></td>            <td>Must be one of: \"ACCOUNT\", \"CONTACT\", \"DEAL\", \"LEAD\", \"BUSINESS_USER\", or \"STAGE\" (case-sensitive)</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>clientRequestId</span></td>            <td>A unique identifier sent by you to allow troubleshooting communication.<br>            Gong also uses this identifier to prevent repeated attempts to upload the same object list.<br>            Valid characters for this field are letters, numbers, dashes and underscores.            </td>            <td>string</td>            <td>Y</td>        </tr>    </tbody></table><h3>Response</h3><code>201 Created</code><table>    <thead>        <tr>            <th>Name</th>            <th>Data Type</th>            <th>Description</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>clientRequestId</span></td>            <td>string</td>            <td>the <span class='public-api-parameter'>clientRequestId</span> sent in the request</td>        </tr>        <tr>            <td><span class='public-api-parameter'>requestId</span></td>            <td>string</td>            <td>A Gong request reference Id, generated for this request</td>        </tr>    </tbody></table><div class='public-api-important'><p><b>Important:</b> The upload objects API is asynchronous. A 201 response only indicates that the file successfully uploaded to Gong and is pending processing. Use the <span class='public-api-parameter'>clientRequestId</span> to troubleshoot failed requests and watch the request status using \"/request-status\" API.</p></div><h3>Error Codes</h3>400 - Malformed request<br>401 - Access denied<br>409 Conflict - clientRequestId already exists<br>429 - API request limit exceeded<br>500 - Internal Server Error<p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:upload'.</p><h2>Common CRM object fields</h2><p>All uploaded CRM objects should contain the following common JSON fields. In addition, each uploaded object should contain mandatory and optional fields as specified below for each object type.</p><table>    <thead>        <tr>            <th>Name</th>            <th>Description</th>            <th>Data Type</th>            <th>Mandatory</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>objectId</span></td>            <td>Each object must have a unique id field provided by the CRM.</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>modifiedDate</span></td>            <td>The object’s last modification date and time in the CRM in ISO-8601 datetime format, without milliseconds</td>            <td>datetime</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>lastModified</span><b>(Deprecated)</b></td>            <td><b>Deprecated</b>. Please use <span class='public-api-parameter'>modifiedDate</span></td>            <td>datetime</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>isDeleted</span></td>            <td>\"true\" deletes the object (For objectType=BUSINESS_USER deletes also the user mapping. For objectType=STAGE sets the stage to inactive). Default = \"false\"</td>            <td>boolean</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>url</span></td>            <td>A full http URL to browse this object in the CRM</td>            <td>string (Qualified URI)</td>            <td>N</td>        </tr>    </tbody></table><h2>Business User Object</h2><p>Gong associates users with the CRM <b>User</b> entity. Mapping users accurately is essential for Gong to connect users with all their associated objects in the CRM.</p><p>Uploading user objects via this API creates a mapping in Gong between the user ID in the CRM system and the user ID in Gong.</p><br><div class='public-api-important'>    <b>Important:</b>    <p>User mapping is important to ensure deals are processed in Gong correctly. Each uploaded deal contains an ownerId field, which contains a user ID from the CRM system.<br>        <b>Gong only processes a deal if this user ID is mapped to a user in Gong who is set to record or import calls.</b>    </p>    <p>On initial upload send the complete list of users from the CRM system. On incremental upload send only users that have changed.</p></div><p>If a user is uploaded after a deal is uploaded:</p><ol>    <li>Gong retroactively searches for deals whose ownerId matches the user ID mapping.</li>    <li>Gong starts to reprocess those matched deals from raw storage into Gong’s main database.</li></ol><p>Gong matches the user from the uploaded JSON to a user in Gong based on the email address.</p><div class='public-api-info'>    <p>The user mapping will not be created when:</p>    <ul>        <li>There is no user in Gong with the supplied email address</li>        <li>Mapping already exists for the supplied email address</li>    </ul></div><p>To update an existing mapping:</p><ol>    <li>Delete the existing mapping by sending the user with isDeleted=true.</li>    <li>In a separate request send the user with isDeleted=false and a new email address, or send a different user for the same email address.</li></ol><p>Business User JSON object requires the following fields:</p><table>    <thead>    <tr>        <th>Name</th>        <th>Description</th>        <th>Data Type</th>        <th>Mandatory</th>    </tr>    </thead>    <tbody>    <tr>        <td><span class='public-api-parameter'>emailAddress</span></td>        <td>Must match an email address of a user in Gong. Not mandatory when isDeleted = true.</td>        <td>string</td>        <td>Y</td>    </tr>    </tbody></table><h3>Example</h3><h4>Request</h4><code>POST https://api.gong.io/v2/crm/object/entities?clientRequestId=1234&integrationId=6286478263646&objectType=BUSINESS_USER</code><br><br><code>    {\"objectId\": \"user1_Id_In_The_CRM\", \"emailAddress\": \"john.doe@acme.com\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\"}<br>    {\"objectId\": \"user2_Id_In_The_CRM\", \"isDeleted\": true, \"emailAddress\": \"john.taylor@acme.com\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\"} // remove user mapping for user user2_Id_In_The_CRM</code><h2>Stage Object</h2><p>Update the list of stages from the CRM system.</p><p>Stages must be uploaded via this API before you upload Deal objects. When you upload your Deal object, make sure that the stage field matches one of the stages you’ve uploaded using this API.</p><div class='public-api-info'>    <p>The upload stages request should only be sent after:</p>    <ul>        <li>You have created a new integration.</li>        <li>There are any changes to the list of stages in the CRM. You can also send a stages update request before any request to the '/object/entities' API.</li>    </ul></div><p>Stage JSON object requires the following fields:</p><table>    <thead>    <tr>        <th>Name</th>        <th>Description</th>        <th>Data Type</th>        <th>Mandatory</th>    </tr>    </thead>    <tbody>    <tr>        <td><span class='public-api-parameter'>internalName</span></td>        <td>Unique name or unique identifier that identifies the stage in the CRM.</td>        <td>string</td>        <td>Y</td>    </tr>    <tr>        <td><span class='public-api-parameter'>name</span></td>        <td>Stage name (for display in Gong UI).</td>        <td>string</td>        <td>Y</td>    </tr>    <tr>        <td><span class='public-api-parameter'>isActive</span></td>        <td>Indicates if the stage is active in the CRM.</td>        <td>boolean</td>        <td>Y</td>    </tr>    <tr>        <td><span class='public-api-parameter'>sortOrder</span></td>        <td>The order of the stage in the sales process (starting from 1).</td>        <td>integer</td>        <td>Y</td>    </tr>    </tbody></table><h3>Example</h3><h4>Request</h4><code>POST https://api.gong.io/v2/crm/object/entities?clientRequestId=1234&integrationId=6286478263646&objectType=STAGE</code><br><br><code>    {\"objectId\": \"discovery\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"internalName\": \"discovery\", \"name\": \"Discovery\", \"isActive\": true, \"sortOrder\": 1}<br>    {\"objectId\": \"won\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"internalName\": \"won\", \"name\": \"Closed Won\", \"isActive\": true, \"sortOrder\": 5}</code><h2>Account Object</h2><ul>    <li>The Account object represents an active customer in the CRM system.</li>    <li>The Account object is used by Gong to connect activities such as emails and calls to their associated account.</li></ul><p>The Deals page displays all the activities in Gong associated with an account as well as account status, contacts, and insights.</p><div class='public-api-info'><p>Contacts and Deals are associated with accounts, and their processing in Gong requires the associated account.</p><p>In order for Deals to be processed correctly by Gong:<ol>    <li>Upload Accounts.</li>    <li>Wait 60 seconds.</li>    <li>Upload Contacts and Deals.</li></ol></p></div><div class='public-api-critical'><p>When deals are being processed, the account referenced by Deal.accountId must exist in the Gong database.<br>If it does not exist in the database, the deal will not be processed or displayed in the Deals page and other areas throughout Gong.</p></div><p>The Account JSON object includes the following fields:</p><table>    <thead>        <tr>            <th>Name</th>            <th>Description</th>            <th>Data Type</th>            <th>Mandatory</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>name</span></td>            <td>Account name</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>domains</span></td>            <td>Domain names related to the account</td>            <td>string array</td>            <td>Y</td>        </tr>    </tbody></table><h3>Example</h3><h4>Request</h4><code>POST https://api.gong.io/v2/crm/object/entities?clientRequestId=1234&integrationId=6286478263646&objectType=ACCOUNT</code><br><br><code>{\"objectId\": \"5ybyh6n6n65\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"url\": \"https://crm.com/accounts/5ybyh6n6n65\", \"name\": \"PBR\", \"domains\": [\"pbr.com\", \"pbr.gov\"], \"type\": \"Investor\"} // account with additional field<br>{\"objectId\": \"gfjhty756th\", \"modifiedDate\": \"2019-01-03T22:45:57Z\", \"name\": \"PBR\", \"domains\": [\"pbr.com\", \"pbr.gov\"], \"isDeleted\": true} // remove account gfjhty756th from Gong</code><h2>Contact Object</h2><ul>    <li>A contact in Gong is a person with contact details associated with the account.</li>    <li>Gong uses a contact to match an activity to the correct account.</li></ul><p>The Contact JSON object includes the following fields:</p><table>    <thead>        <tr>            <th>Name</th>            <th>Description</th>            <th>Data Type</th>            <th>Mandatory</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>accountId</span></td>            <td>The ID of the contact’s connected account in the CRM</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>emailAddress</span></td>            <td>The contact’s main email address</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>firstName</span></td>            <td>The contact’s first name</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>lastName</span></td>            <td>The contact’s last name</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>title</span></td>            <td>The contact’s title (if available)</td>            <td>string</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>phoneNumber</span></td>            <td>The contact’s main phone number.<br>            If Gong is configured to import dialer calls the phoneNumber parameter is mandatory.            </td>            <td>string</td>            <td>Y for dialer calls,<br>            N otherwise            </td>        </tr>    </tbody></table><h3>Example</h3><h4>Request</h4><code>POST https://api.gong.io/v2/crm/object/entities?clientRequestId=1234&integrationId=6286478263646&objectType=CONTACT</code><br><br><code>{\"objectId\": \"5zbwd7n5n65\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"url\": \"https://crm.com/contacts/5zbwd7n5n65\", \"accountId\": \"5ybyh6n6n65\", \"emailAddress\": \"john.smith@acme.com\", \"firstName\": \"john\", \"lastName\": \"smith\", \"phoneNumber\": \"(912) 507-4395\"}</code><h2>Lead Object</h2><ul>    <li>The Lead object represents a potential customer.</li>    <li>Calls and emails are first associated with contacts based on email addresses.</li>    <li>If there is no matching contact, Gong tries to match calls and emails to a lead.</li></ul><p>The Lead JSON object includes the following fields:</p><table>    <thead>        <tr>            <th>Name</th>            <th>Description</th>            <th>Data Type</th>            <th>Mandatory</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>emailAddress</span></td>            <td>The Lead’s main email address</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>firstName</span></td>            <td>The Lead’s first name</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>lastName</span></td>            <td>The Lead’s last name</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>title</span></td>            <td>The Lead’s title (if available)</td>            <td>string</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>phoneNumber</span></td>            <td>The Lead’s phone number.<br>            If Gong is configured to import dialer calls the phoneNumber parameter is mandatory.            </td>            <td>string</td>            <td>Y for dialer calls,<br>            N otherwise            </td>        </tr>        <tr>            <td><span class='public-api-parameter'>convertedToDealId</span></td>            <td>The deal CRM ID, if the lead was converted to a Deal</td>            <td>string</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>convertedToContactId</span></td>            <td>The contact CRM ID if the lead was converted to a Contact</td>            <td>string</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>convertedToAccountId</span></td>            <td>The account CRM ID if the lead was converted to an Account</td>            <td>string</td>            <td>N</td>        </tr>    </tbody></table><h3>Example</h3><h4>Request</h4><code>POST https://api.gong.io/v2/crm/object/entities?clientRequestId=1234&integrationId=6286478263646&objectType=LEAD</code><br><br><code>{\"objectId\": \"4v5bt54t553\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"url\": \"https://crm.com/leads/45k4j5j5k44\", \"emailAddress\": \"jane.doe@acme.com\", \"firstName\": \"Jane\", \"lastName\": \"Doe\", \"title\": \"VP Special Effects\", \"phoneNumber\": \"(912) 507-4395\"}<br>{\"objectId\": \"gf4543gf6th\", \"modifiedDate\": \"2019-01-03T22:45:57Z\", \"emailAddress\": \"john.smith@acme.com\", \"firstName\": \"John\", \"lastName\": \"Smith\", \"isDeleted\": true} // remove lead gf4543gf6th<br>{\"objectId\": \"63473hjg53h\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"emailAddress\": \"bob.smith@acme.com\", \"firstName\": \"Bob\", \"lastName\": \"Smith\", \"convertedToDealId\": \"dkfj8dfgf87\", \"convertedToContactId\": \"87grhn74hg6\", \"convertedToAccountId\": \"6sjk47jf78d\"} // lead 63473hjg53h converted to account 6sjk47jf78d, contact 87grhn74hg6 and deal dkfj8dfgf87</code><h2>Deal Object</h2><p>A deal in Gong represents a qualified opportunity or contract in a specific account.</p><p>The Deal JSON object includes the following fields:</p><table>    <thead>        <tr>            <th>Name</th>            <th>Description</th>            <th>Data Type</th>            <th>Mandatory</th>        </tr>    </thead>    <tbody>        <tr>            <td><span class='public-api-parameter'>accountId</span></td>            <td>            <p>The ID of the account the deal is associated with in the CRM</p>            <div class='public-api-info'>                <p>An account with the same objectId must be uploaded first in order for the deal to be processed. The accountId needs to match an Account with the same value in its objectId.</p>            </div>            </td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>ownerId</span></td>            <td>            <p>The ID of the owning User in the CRM</p>            <div class='public-api-info'>                <p>This field is a reference to a CRM user which must be mapped to a Gong user via \"/map/users\" API and the Gong user must be set to record or import calls, otherwise the deal will not be processed</p>            </div>            </td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>name</span></td>            <td>The deal’s name</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>createdDate</span></td>            <td>The deal’s creation date and time (ISO-8601 datetime without milliseconds)</td>            <td>datetime</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>estimatedCloseDate</span>*<b>(Deprecated)</b></td>            <td><b>Deprecated</b>. Please use <span class='public-api-parameter'>closeDate</span> instead</td>            <td>date</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>actualCloseDate</span>*<b>(Deprecated)</b></td>            <td><b>Deprecated</b>. Please use <span class='public-api-parameter'>closeDate</span> instead</td>            <td>date</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>closeDate</span></td>            <td>The deal’s close date (ISO-8601), without time e.g. \"2021-05-19\"</td>            <td>date</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>isOpen</span></td>            <td>Indicates if the Deal’s status is Open or Closed</td>            <td>boolean</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>isWon</span></td>            <td>Indicates if the Deal’s status is Won or Lost</td>            <td>boolean</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>stage</span></td>            <td>The value of this field must be equal to the internalName of one of the stages uploaded via \"/stages\" API</td>            <td>string</td>            <td>Y</td>        </tr>        <tr>            <td><span class='public-api-parameter'>estimatedAmount</span>**<b>(Deprecated)</b></td>            <td><b>Deprecated</b>. Please use <span class='public-api-parameter'>amount</span> instead</td>            <td>currency</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>actualAmount</span>**<b>(Deprecated)</b></td>            <td><b>Deprecated</b>. Please use <span class='public-api-parameter'>amount</span> instead</td>            <td>currency</td>            <td>N</td>        </tr>        <tr>            <td><span class='public-api-parameter'>amount</span></td>            <td>The deal’s amount in the currency unit</td>            <td>currency</td>            <td>Y</td>        </tr>    </tbody></table><p>* Either <span class='public-api-parameter'>estimatedCloseDate</span> or <span class='public-api-parameter'>actualCloseDate</span> (or both) must exist in the JSON<br>** Either <span class='public-api-parameter'>estimatedAmount</span> or <span class='public-api-parameter'>actualAmount</span> (or both) must exist in the JSON</p><h3>Example</h3><h4>Request</h4><code>POST https://api.gong.io/v2/crm/object/entities?clientRequestId=1234&integrationId=6286478263646&objectType=DEAL</code><br><br><code>{\"objectId\": \"8608553\", \"modifiedDate\": \"2022-02-04T18:24:59Z\", \"url\": \"http://crm.com/deals/8608553\", \"accountId\": \"5ybyh6n6n65\", \"ownerId\": \"5486951\", \"name\": \"Deal name\", \"createdDate\": \"2022-02-04T17:57:23Z\", \"closeDate\": \"2022-09-04\", \"isOpen\": true, \"isWon\": false, \"stage\": \"discovery\", \"amount\": 7000, \"custom_field_1\": \"2022-02-04T17:57:23.000Z\", \"custom_field_2\": null}</code><h2>Additional Fields</h2><p>In addition to the fields required by Gong, you can also add any other field to each object if the following two conditions are met:<ul>    <li>The field name is defined in the object's schema and has been uploaded using \"/object/schema\" API</li>    <li>The field value matches the type defined in the schema</li></ul></p>","operationId":"uploadCrmDataUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"dataFile","in":"formData","required":false,"type":"file"}],"responses":{"201":{"description":"Successfully registered the new crm data","responseSchema":{"$ref":"#/definitions/AsyncProcessingResponse","originalRef":"#/definitions/AsyncProcessingResponse"},"schema":{"$ref":"#/definitions/AsyncProcessingResponse","originalRef":"#/definitions/AsyncProcessingResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"409":{"description":"Client request id has already been used","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/object/list":{"get":{"tags":["CRM"],"summary":"Get CRM objects (/v2/crm/object/list)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>This API is intended to be used in <b>development phase only</b>, to manually verify that objects are uploaded and processed correctly in Gong.</p><p>Returns a JSON object where each key is the object crm id and the corresponding value is a nested JSON object representing the CRM object fields. Each key in the nested JSON is the field name and the corresponding value is the field value.</p><p>The objects are fetched from the Gong main DB. If the object is not found, the JSON’s value will be null.</p><p>The request body contains an array of objects ids.</p><p>The request is limited to 100 objects. If more than 100 objects are requested only the first 100 are returned.</p><p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:get-objects'.</p>","operationId":"getCrmObjectsUsingGET","produces":["application/json"],"parameters":[{"name":"integrationId","in":"query","description":"Integration ID generated when creating the integration","required":true,"type":"integer","format":"int64"},{"in":"body","name":"objectsCrmIds","description":"Requested objects crm ids","required":true,"schema":{"type":"array","items":{"type":"string"},"example":"[\"1234\",\"8765\"]"}},{"name":"objectType","in":"query","description":"Requested objects type","required":true,"type":"string","enum":["ACCOUNT","CONTACT","DEAL","LEAD"]}],"responses":{"200":{"description":"Successfully retrieved requested objects data","responseSchema":{"$ref":"#/definitions/GetGenericCrmObjectsResponse","originalRef":"#/definitions/GetGenericCrmObjectsResponse"},"schema":{"$ref":"#/definitions/GetGenericCrmObjectsResponse","originalRef":"#/definitions/GetGenericCrmObjectsResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/object/schema":{"post":{"tags":["CRM"],"summary":"Upload Object Schema (/v2/crm/object/schema)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>All CRM object fields in Gong must have a representative schema that describes the field (unique name, type, etc.). <br>Any field uploaded by the \"Upload CRM objects\" API (\"/object/entities\" path) that is not described in the schema will be stored in Gong’s raw data storage. However, it will not be parsed by Gong and it will not be available to the end user.</p><p>For new integrations created via \"/integration/new\" API, Gong creates a default schema for each object type (Contact, Account, Deal, Lead) that contains the mandatory and optional fields specified in this guide. See the <b>Upload CRM objects</b> API section for more information.<br>If there are additional fields for any object type that are needed by the end user, send their schema via this API.</p><p><div class='public-api-info'>The schema update request should be sent when:<ul>    <li>You have created a new integration.</li>    <li>There are changes to the schema of any object type. You can also send a schema update request before any request to the '/object/entities' API.</li></ul></div></p><p><div class='public-api-important'>Each schema update request must contain the full schema from your CRM. Fields that were sent in previous requests and no longer exist in your CRM, should be sent in the schema request with \"isDeleted=true\" (only once).</div></p><p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:schema'.</p><h3>Supported Field Types</h3><table>  <thead>  <tr>    <th>Field Type</th>    <th>Format in JSON</th>    <th>Sample Values</th>  </tr>  </thead>  <tbody>  <tr>    <td><span class='public-api-parameter'>BOOLEAN</span></td>    <td>boolean</td>    <td>true, false</td>  </tr>  <tr>    <td><span class='public-api-parameter'>DATE</span></td>    <td>string (ISO-8601 date without time)</td>    <td>\"2020-05-31\"</td>  </tr>  <tr>    <td><span class='public-api-parameter'>DATETIME</span></td>    <td>string (ISO-8601 datetime without milliseconds)</td>    <td>\"2020-12-17T07:37:21+02:00\"<br>\"2020-12-17T05:37:21Z\"</td>  </tr>  <tr>    <td><span class='public-api-parameter'>PICKLIST</span></td>    <td>string - one of the values in an orderedValueList</td>    <td>\"Analyst\"</td>  </tr>  <tr>    <td><span class='public-api-parameter'>NUMBER</span></td>    <td>number</td>    <td>45.66, 8453</td>  </tr>  <tr>    <td><span class='public-api-parameter'>PERCENT</span></td>    <td>number (between 0 to 100)</td>    <td>67.3</td>  </tr>  <tr>    <td><span class='public-api-parameter'>CURRENCY</span>*</td>    <td>number</td>    <td>34.68</td>  </tr>  <tr>    <td><span class='public-api-parameter'>PHONENUMBER</span></td>    <td>string</td>    <td>\"+14055766687\"</td>  </tr>  <tr>    <td><span class='public-api-parameter'>EMAILADDRESS</span></td>    <td>string</td>    <td>\"john.doe@anywhere.com\"</td>  </tr>  <tr>    <td><span class='public-api-parameter'>REFERENCE</span></td>    <td>string - the id of another object</td>    <td>\"48b009drax\"</td>  </tr>  <tr>    <td><span class='public-api-parameter'>ID</span></td>    <td>string - the id of the object</td>    <td>\"843hf8484jr84htg\"</td>  </tr>  <tr>    <td><span class='public-api-parameter'>STRING</span></td>    <td>string</td>    <td>\"whatever you want\"</td>  </tr>  <tr>    <td><span class='public-api-parameter'>STRINGARRAY</span>**</td>    <td>array of strings</td>    <td>[\"http://customer.com\"]</td>  </tr>  <tr>    <td><span class='public-api-parameter'>URL</span></td>    <td>string</td>    <td>\"https://crm.com/account/6d4r578f\"</td>  </tr>  </tbody></table><p>* In the integration send a number value, and specify the correct currency symbol in the Gong UI. Currently  Gong does not support multiple currencies per company.<br>** Can only be used for Gong-defined fields.</p><h3>Example</h3><h4>Request</h4><code>POST https://api.gong.io/v2/crm/object/schema?integrationId=6286478263646&objectType=ACCOUNT</code><br><br><code>[{\"uniqueName\": \"orderId\", \"label\": \"ID\", \"type\": \"ID\", \"lastModified\": \"2020-11-11T08:11:34+01:00\"},<br>{\"uniqueName\": \"parentAccount\", \"label\": \"Main Account\", \"type\": \"REFERENCE\", \"referenceTo\": \"ACCOUNT\", \"lastModified\": \"2020-11-11T08:11:34+01:00\"},<br>{\"uniqueName\": \"category\", \"label\": \"Category\", \"type\": \"PICKLIST\", \"orderedValueList\": [\"Analyst\", \"Competitor\", \"Customer\", \"Integrator\", \"Investor\", \"Partner\", \"Other\"], \"lastModified\": \"2020-11-11T08:11:34+01:00\"}, // custom field<br>{\"uniqueName\": \"industry\", \"isDeleted\": true, \"lastModified\": \"2020-11-21T08:11:34+01:00\"}] // remove custom field</code>","operationId":"uploadCrmSchemaFieldUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"fields","description":"fields","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/GenericSchemaFieldRequest","originalRef":"#/definitions/GenericSchemaFieldRequest"}}},{"name":"integrationId","in":"query","description":"Integration ID generated when creating the integration","required":true,"type":"integer","format":"int64"},{"name":"objectType","in":"query","description":"Type of object to set the schema for (case-sensitive)","required":true,"type":"string","enum":["ACCOUNT","CONTACT","DEAL","LEAD"]}],"responses":{"200":{"description":"Successfully uploaded crm schema fields","responseSchema":{"$ref":"#/definitions/SchemaUpdateResponse","originalRef":"#/definitions/SchemaUpdateResponse"},"schema":{"$ref":"#/definitions/SchemaUpdateResponse","originalRef":"#/definitions/SchemaUpdateResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/object/schema/list":{"get":{"tags":["CRM"],"summary":"List Schema Fields (/v2/crm/object/schema/list)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>Retrieves a list of the object schema fields.</p><p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:schema'.</p><h3>Example</h3><h4>Request</h4><code>GET https://api.gong.io/v2/crm/object/schema/list?integrationId=6286478263646&objectType=ACCOUNT</code><h4>Response</h4><code>{    \"requestId\": \"afjkzqkqglog7ueki5\",    \"selectedFields\": {        \"ACCOUNT\": [            {                \"name\": \"accountTypePicklist\",                \"label\": \"Account Type\",                \"type\": \"PICKLIST\",                \"lastModified\": null,                \"isDeleted\": false,                \"referenceTo\": null,                \"orderedValueList\": null            },            {                \"name\": \"accountTypePicklist2\",                \"label\": \"Account Type2\",                \"type\": \"PICKLIST\",                \"lastModified\": null,                \"isDeleted\": false,                \"referenceTo\": null,                \"orderedValueList\": null            },            {                \"name\": \"fooBar\",                \"label\": \"Foo Bar\",                \"type\": \"STRING\",                \"lastModified\": null,                \"isDeleted\": false,                \"referenceTo\": null,                \"orderedValueList\": null            }        ]    }}</code>","operationId":"listCrmSchemaFieldsUsingGET","produces":["application/json"],"parameters":[{"name":"integrationId","in":"query","description":"Integration ID generated when creating the integration","required":true,"type":"integer","format":"int64"},{"name":"objectType","in":"query","description":"Type of object to retrieve the schema fields for (case-sensitive). <br>Omitting this parameter returns the schema for all object types.","required":true,"type":"string","enum":["ACCOUNT","CONTACT","DEAL","LEAD"]}],"responses":{"200":{"description":"Successfully retrieved crm schema fields","responseSchema":{"$ref":"#/definitions/ListSelectedFieldsResponse","originalRef":"#/definitions/ListSelectedFieldsResponse"},"schema":{"$ref":"#/definitions/ListSelectedFieldsResponse","originalRef":"#/definitions/ListSelectedFieldsResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/request-status":{"get":{"tags":["CRM"],"summary":"Get Request Status (/v2/crm/request-status)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>Returns the current status of the request for \"/map/users\", \"/object/entities\" or \"/integration/delete\" API.</p><p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:upload'.</p><h3>Status Codes</h3><ul>    <li><span class='public-api-parameter'>PENDING</span> - File is pending parsing</li>    <li><span class='public-api-note'>IN_PROGRESS</span> - File is being parsed</li>    <li><span class='public-api-info'>DONE</span> - All objects in the file were successfully parsed</li>    <li><span class='public-api-critical'>FAILED</span> - Failed to parse some objects in the file or on a general error when the file was being processed</li></ul><h3>Status Indication</h3><ul>    <li>For \"/object/entities\" API, status <span class='public-api-info'>DONE</span> indicates that all objects in the LDJSON file were successfully parsed and stored in raw storage.<br>        Note that it can take up to 1 hour from the time the LDJSON file was uploaded using the \"/object/entities\" API until deals are fully processed and available to the end user on the Deals Board.    </li>    <li>For \"/map/users\" API, status <span class='public-api-info'>DONE</span> indicates that the mapping was successfully created and is available in Gong for the processing of other objects.</li>    <li><span class='public-api-critical'>FAILED</span>:        <ul>            <li>If you receive a <span class='public-api-critical'>FAILED</span> status with a specific error list there are errors you need to address in the object:                <ul>                    <li>Fix the objects' JSON.</li>                    <li>Resend the entire LDJSON file to \"/object/entities\" or \"/map/users\" API.<br>                        Note that The returned errors list is <b>limited to the first 20 errors</b>. To make sure you have corrected all the possible errors you need to upload the entire file repeatedly until you receive a <span class='public-api-info'>DONE</span> status.                    </li>                </ul>            </li>            <li>If you received a <span class='public-api-critical'>FAILED</span> status with a single error in the form of<br>                {\"line\":0,\"description\":\".....\"} this indicates a general processing error:                <ul>                    <li>Fix the LDJSON file according to the error message.</li>                    <li>Upload the entire LDJSON file again.</li>                </ul>            </li>        </ul>    </li></ul>","operationId":"getRequestStatusUsingGET","produces":["application/json"],"parameters":[{"name":"clientRequestId","in":"query","description":"<span style='background: rgba(9,30,66,0.08)'>clientRequestId</span> sent to \"/map/users\", \"/object/entities\" or \"/integration/delete\" API","required":true,"type":"string"},{"name":"integrationId","in":"query","description":"Integration ID generated when creating the integration","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Operation successful","responseSchema":{"$ref":"#/definitions/RequestStatusResponse","originalRef":"#/definitions/RequestStatusResponse"},"schema":{"$ref":"#/definitions/RequestStatusResponse","originalRef":"#/definitions/RequestStatusResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/crm/stages":{"post":{"tags":["CRM"],"summary":"Upload Stages (Deprecated)","description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style><p>This API is <b>Deprecated</b>. Please use \"/object/entities?objectType=STAGE\" API instead.</p><p>Update the list of stages from the CRM system.</p><p>This API must be called before you upload Deal objects. When you upload your Deal object, make sure that the stage field matches one of the stages you’ve uploaded using this API.</p><div class='public-api-info'><p>The upload stages request should only be sent after:</p><ul>    <li>You have created a new integration.</li>    <li>There are any changes to the list of stages in the CRM. You can also send a stages update request before any request to the '/object/entities' API.</li></ul></div><p>When accessed using a bearer token, this endpoint requires the scope 'api:crm:schema'.</p>","operationId":"uploadStagesUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"integrationId","in":"query","description":"Integration ID generated when creating the integration","required":true,"type":"integer","format":"int64"},{"in":"body","name":"stages","description":"stages","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/GenericDealStageRequest","originalRef":"#/definitions/GenericDealStageRequest"}}}],"responses":{"200":{"description":"Successfully uploaded deal stages","responseSchema":{"$ref":"#/definitions/SchemaUpdateResponse","originalRef":"#/definitions/SchemaUpdateResponse"},"schema":{"$ref":"#/definitions/SchemaUpdateResponse","originalRef":"#/definitions/SchemaUpdateResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/customer-engagement/action":{"put":{"tags":["Engagement (in Beta Phase)"],"summary":"Report event of a custom action (/v2/customer-engagement/action)","description":"Push engagement events into Gong and display them as events in Gong’s activity timeline, when a content is engaged by an external participant (for example, a contract was “signed” by the prospect)\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.","operationId":"customActionUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CustomActionEvent","originalRef":"#/definitions/CustomActionEvent"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"},"schema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"}},"400":{"description":"Malformed request"},"401":{"description":"Access denied"},"409":{"description":"Conflict - Event was already reported in the past."},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}}},"500":{"description":"Failed to complete the operation due to an unexpected error"}}}},"/v2/customer-engagement/content/shared":{"put":{"tags":["Engagement (in Beta Phase)"],"summary":"Report event of a content share (/v2/customer-engagement/content/shared)","description":"Push engagement events into Gong and display them as events in Gong’s activity timeline, when a Gong user shares content with external participants (for example, a contract was “shared” by the account executive with his prospects)\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.","operationId":"contentSharedUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/ContentSharedEvent","originalRef":"#/definitions/ContentSharedEvent"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"},"schema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"}},"400":{"description":"Malformed request"},"401":{"description":"Access denied"},"409":{"description":"Conflict - Event was already reported in the past."},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}}},"500":{"description":"Failed to complete the operation due to an unexpected error"}}}},"/v2/customer-engagement/content/viewed":{"put":{"tags":["Engagement (in Beta Phase)"],"summary":"Report event of a content view (/v2/customer-engagement/content/viewed)","description":"Push engagement events into Gong and display them as events in Gong’s activity timeline, when a content is viewed by an external participant (for example, a contract was “viewed” by the prospect)\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.","operationId":"contentViewedUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/ContentViewedEvent","originalRef":"#/definitions/ContentViewedEvent"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"},"schema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"}},"400":{"description":"Malformed request"},"401":{"description":"Access denied"},"409":{"description":"Conflict - Event was already reported in the past."},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}}},"500":{"description":"Failed to complete the operation due to an unexpected error"}}}},"/v2/data-privacy/data-for-email-address":{"get":{"tags":["Data Privacy"],"summary":"Retrieve all references to an email address. (/v2/data-privacy/data-for-email-address)","description":"Shows the elements in the Gong system that reference the given email address. Given an emails address, this endpoint returns details of all calls and email messages that reference this address, and any leads or contacts with this email address.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.","operationId":"findAllReferencesToEmailAddressUsingGET","produces":["application/json"],"parameters":[{"name":"emailAddress","in":"query","description":"The email address.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful request","responseSchema":{"$ref":"#/definitions/EmailAddressReferences","originalRef":"#/definitions/EmailAddressReferences"},"schema":{"$ref":"#/definitions/EmailAddressReferences","originalRef":"#/definitions/EmailAddressReferences"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/data-privacy/data-for-phone-number":{"get":{"tags":["Data Privacy"],"summary":"Retrieve all references to a phone number. (/v2/data-privacy/data-for-phone-number)","description":"Shows the elements in the Gong system that reference the given phone number. Given a phone number, this endpoint returns details of any leads or contacts with this phone number and their associated calls and email messages.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.","operationId":"findAllReferencesToPhoneNumberUsingGET","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"The phone number.\n\nThis number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored.\n\nThe following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc.\n\nNote: This parameter should be URL-encoded.","required":true,"type":"string","x-example":"+1(425) 555-2671"}],"responses":{"200":{"description":"Successful request","responseSchema":{"$ref":"#/definitions/PhoneNumberReferences","originalRef":"#/definitions/PhoneNumberReferences"},"schema":{"$ref":"#/definitions/PhoneNumberReferences","originalRef":"#/definitions/PhoneNumberReferences"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/data-privacy/erase-data-for-email-address":{"post":{"tags":["Data Privacy"],"summary":"Delete the email address, and all associated elements (/v2/data-privacy/erase-data-for-email-address)","description":"Given an email address, this endpoint deletes from the Gong system any calls or email messages that reference this address. Email messages sent to or from the address are deleted. Calls where the email address appears (as a lead, contact, attendee or speaker) are deleted. Leads or Contacts with the email address are deleted. The deletion is not immediate, and may take several hours to complete.\n\nThis endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. If the deletion fails please contact support at help@gong.io\n\nDelete the data from your CRM and email system before performing this operation so that private data is not re-imported into Gong.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.","operationId":"purgeEmailAddressUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"emailAddress","in":"query","description":"The email address.","required":true,"type":"string"}],"responses":{"200":{"description":"Success","responseSchema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"},"schema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/data-privacy/erase-data-for-phone-number":{"post":{"tags":["Data Privacy"],"summary":"Delete the phone number, and all associated elements (/v2/data-privacy/erase-data-for-phone-number)","description":"Given a phone number, this endpoint deletes from the Gong system any leads or contacts with a matching phone number or mobile phone number. Email messages sent to or from these leads/contacts are deleted. Calls where the leads/contacts appear are deleted. The deletion is not immediate, and may take several hours to complete.\n\nThis endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. If the deletion fails please contact support at help@gong.io\n\nDelete the data from your CRM and email system before performing this operation so that private data is not re-imported into Gong.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.","operationId":"purgePhoneNumberUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"The phone number.\n\nThis number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored.\n\nThe following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc.\n\nNote: This parameter should be URL-encoded.","required":true,"type":"string","x-example":"+1(425) 555-2671"}],"responses":{"200":{"description":"Success","responseSchema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"},"schema":{"$ref":"#/definitions/BaseResponse","originalRef":"#/definitions/BaseResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/library/folder-content":{"get":{"tags":["Library"],"summary":"List of calls in a specific folder (/v2/library/folder-content)","description":"Given a folder id, this endpoint retrieves a list of calls in it.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:library:read'.","operationId":"getCallsInSpecificFolderUsingGET","produces":["application/json"],"parameters":[{"name":"folderId","in":"query","description":"Gong's unique numeric identifier for the folder (up to 20 digits).","required":false,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/LibraryFolderListOfCallsResponse","originalRef":"#/definitions/LibraryFolderListOfCallsResponse"},"schema":{"$ref":"#/definitions/LibraryFolderListOfCallsResponse","originalRef":"#/definitions/LibraryFolderListOfCallsResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No folders found for the specified period","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/library/folders":{"get":{"tags":["Library"],"summary":"Retrieve Library folders (/v2/library/folders)","description":"Use this endpoint to retrieve a list of public library folders. We do not allow retrieval of either private or archived folders.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:library:read'.","operationId":"getLibraryStructureUsingGET","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace identifier. We will retrieve folders which are related to this specific workspace.","required":false,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/LibraryResponse","originalRef":"#/definitions/LibraryResponse"},"schema":{"$ref":"#/definitions/LibraryResponse","originalRef":"#/definitions/LibraryResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No folders found for the specified period","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/logs":{"get":{"tags":["Auditing"],"summary":"Retrieve logs data by type and time range (/v2/logs)","description":"List log entries that took place during a specified time range.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:logs:read'.","operationId":"listLogsUsingGET","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records.","required":false,"type":"string","x-example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM"},{"name":"fromDateTime","in":"query","description":"The time from which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).","required":true,"type":"string"},{"name":"logType","in":"query","description":"Type of logs requested.","required":true,"type":"string","enum":["AccessLog","ExternallySharedCallAccess","ExternallySharedCallPlay","UserActivityLog","UserCallPlay"]},{"name":"toDateTime","in":"query","description":"The time until which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the logs end with the latest recorded log.","required":false,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/LogsResponse","originalRef":"#/definitions/LogsResponse"},"schema":{"$ref":"#/definitions/LogsResponse","originalRef":"#/definitions/LogsResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No logs found for the specified period","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/meetings":{"post":{"tags":["Meetings (in Beta Phase)"],"summary":"Create a New Gong Meeting (/v2/meetings)","description":"When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'.","operationId":"addMeetingUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"newMeetingRequest","description":"newMeetingRequest","required":true,"schema":{"$ref":"#/definitions/NewMeetingRequest","originalRef":"#/definitions/NewMeetingRequest"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/NewMeetingResponse","originalRef":"#/definitions/NewMeetingResponse"},"schema":{"$ref":"#/definitions/NewMeetingResponse","originalRef":"#/definitions/NewMeetingResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"403":{"description":"This API endpoint is in Limited release - contact your CSM for more information.","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No Gong user found corresponding to the provided organizer email","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict, e.g. consent page is not enabled in your company","responseSchema":{"$ref":"#/definitions/MeetingsErrorResponse","originalRef":"#/definitions/MeetingsErrorResponse"},"schema":{"$ref":"#/definitions/MeetingsErrorResponse","originalRef":"#/definitions/MeetingsErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/meetings/integration/status":{"post":{"tags":["Meetings (in Beta Phase)"],"summary":"Validate Gong meeting Integration (/v2/meetings/integration/status)","description":"When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:integration:status'.","operationId":"integrationStatusUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"integrationStatusRequest","description":"integrationStatusRequest","required":true,"schema":{"$ref":"#/definitions/IntegrationStatusRequest","originalRef":"#/definitions/IntegrationStatusRequest"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/IntegrationStatusResponse","originalRef":"#/definitions/IntegrationStatusResponse"},"schema":{"$ref":"#/definitions/IntegrationStatusResponse","originalRef":"#/definitions/IntegrationStatusResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"403":{"description":"Access denied"},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/meetings/{meetingId}":{"put":{"tags":["Meetings (in Beta Phase)"],"summary":"Update a Gong Meeting (/v2/meetings/{meetingId})","description":"When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'.","operationId":"updateMeetingUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"meetingId","in":"path","description":"Gong's unique identifier for the meeting (up to 20 digits).","required":true,"type":"integer","format":"int64"},{"in":"body","name":"updateMeetingRequest","description":"updateMeetingRequest","required":true,"schema":{"$ref":"#/definitions/UpdateMeetingRequest","originalRef":"#/definitions/UpdateMeetingRequest"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/UpdateMeetingResponse","originalRef":"#/definitions/UpdateMeetingResponse"},"schema":{"$ref":"#/definitions/UpdateMeetingResponse","originalRef":"#/definitions/UpdateMeetingResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"403":{"description":"This API endpoint is in Limited release - contact your CSM for more information.","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No meeting found corresponding to the provided meeting ID","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict, e.g. consent page is not enabled in your company","responseSchema":{"$ref":"#/definitions/MeetingsErrorResponse","originalRef":"#/definitions/MeetingsErrorResponse"},"schema":{"$ref":"#/definitions/MeetingsErrorResponse","originalRef":"#/definitions/MeetingsErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}},"delete":{"tags":["Meetings (in Beta Phase)"],"summary":"Delete a Gong Meeting (/v2/meetings)","description":"When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:delete'.","operationId":"deleteMeetingUsingDELETE","produces":["application/json"],"parameters":[{"name":"meetingId","in":"path","description":"Gong's unique identifier for the meeting (up to 20 digits).","required":true,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/DeleteMeetingRequest","originalRef":"#/definitions/DeleteMeetingRequest"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/DeleteMeetingRequest","originalRef":"#/definitions/DeleteMeetingRequest"},"schema":{"$ref":"#/definitions/DeleteMeetingRequest","originalRef":"#/definitions/DeleteMeetingRequest"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"403":{"description":"This API endpoint is in Limited release - contact your CSM for more information.","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No Gong meeting found corresponding to the provided organizer email","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict, e.g. consent page is not enabled in your company","responseSchema":{"$ref":"#/definitions/MeetingsErrorResponse","originalRef":"#/definitions/MeetingsErrorResponse"},"schema":{"$ref":"#/definitions/MeetingsErrorResponse","originalRef":"#/definitions/MeetingsErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/permission-profile":{"get":{"tags":["Permissions"],"summary":"Permission profile for a given profile Id (/v2/permission-profile)","description":"Returns a permission profile.","operationId":"getPermissionProfileUsingGET","produces":["application/json"],"parameters":[{"name":"profileId","in":"query","description":"Permission profile identifier.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/PermissionProfileResponse","originalRef":"#/definitions/PermissionProfileResponse"},"schema":{"$ref":"#/definitions/PermissionProfileResponse","originalRef":"#/definitions/PermissionProfileResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}},"post":{"tags":["Permissions"],"summary":"Create permission profile (/v2/permission-profile)","description":"Create a permission profile in a given workspace.","operationId":"createPermissionProfileUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"permissionProfileDTO","description":"permissionProfileDTO","required":true,"schema":{"$ref":"#/definitions/PermissionProfileDTO","originalRef":"#/definitions/PermissionProfileDTO"}},{"name":"workspaceId","in":"query","description":"Workspace identifier.\n\nYou can retrieve the workspace using the \"workspaces\" (under \"Settings\") API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/PermissionProfileResponse","originalRef":"#/definitions/PermissionProfileResponse"},"schema":{"$ref":"#/definitions/PermissionProfileResponse","originalRef":"#/definitions/PermissionProfileResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}},"put":{"tags":["Permissions"],"summary":"Update permission profile (/v2/permission-profile)","description":"Update a permission profile.","operationId":"updatePermissionProfileUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"permissionProfileDTO","description":"permissionProfileDTO","required":true,"schema":{"$ref":"#/definitions/PermissionProfileDTO","originalRef":"#/definitions/PermissionProfileDTO"}},{"name":"profileId","in":"query","description":"Permission profile identifier.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response - returns the entire permission profile after applying the changes.","responseSchema":{"$ref":"#/definitions/PermissionProfileResponse","originalRef":"#/definitions/PermissionProfileResponse"},"schema":{"$ref":"#/definitions/PermissionProfileResponse","originalRef":"#/definitions/PermissionProfileResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/permission-profile/users":{"get":{"tags":["Permissions"],"summary":"List all users attached to a given permission profile (/v2/permission-profile/users)","description":"Returns a list of all users whose access is controlled by the given permission profile.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.","operationId":"listPermissionProfileUsersUsingGET","produces":["application/json"],"parameters":[{"name":"profileId","in":"query","description":"Permission profile identifier.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/PermissionProfileUsersResponse","originalRef":"#/definitions/PermissionProfileUsersResponse"},"schema":{"$ref":"#/definitions/PermissionProfileUsersResponse","originalRef":"#/definitions/PermissionProfileUsersResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/settings/scorecards":{"get":{"tags":["Settings"],"summary":"Retrieve scorecards details (/v2/settings/scorecards)","description":"Retrieve all the scorecards within the Gong system.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:settings:scorecards:read'.","operationId":"listScorecardsUsingGET","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/Scorecards","originalRef":"#/definitions/Scorecards"},"schema":{"$ref":"#/definitions/Scorecards","originalRef":"#/definitions/Scorecards"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"Scorecards not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/stats/activity/aggregate":{"post":{"tags":["Stats"],"summary":"Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate)","description":"Lists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user's activity.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.","operationId":"listMultipleUsersAggregateActivityUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"multipleUsersRequest","description":"multipleUsersRequest","required":true,"schema":{"$ref":"#/definitions/Request«MultipleUsersWithDates»","originalRef":"#/definitions/Request«MultipleUsersWithDates»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/CompanyUsersAggregateActivityResponse","originalRef":"#/definitions/CompanyUsersAggregateActivityResponse"},"schema":{"$ref":"#/definitions/CompanyUsersAggregateActivityResponse","originalRef":"#/definitions/CompanyUsersAggregateActivityResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"User not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/stats/activity/aggregate-by-period":{"post":{"tags":["Stats"],"summary":"Retrieve aggregated activity for defined users by a date range with grouping in time periods (/v2/stats/activity/aggregate-by-period)","description":"Lists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. This endpoint returns multiple records, one for each user. For each user there are items for every time period in the date range, including statistics about the user's activity. Records are returned only for users with activity in the range.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.","operationId":"listMultipleUsersAggregateByPeriodUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"multipleUsersRequest","description":"multipleUsersRequest","required":true,"schema":{"$ref":"#/definitions/RequestWithTimePeriod«MultipleUsersWithDates»","originalRef":"#/definitions/RequestWithTimePeriod«MultipleUsersWithDates»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/UsersAggregateByPeriodActivity","originalRef":"#/definitions/UsersAggregateByPeriodActivity"},"schema":{"$ref":"#/definitions/UsersAggregateByPeriodActivity","originalRef":"#/definitions/UsersAggregateByPeriodActivity"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"User not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/stats/activity/day-by-day":{"post":{"tags":["Stats"],"summary":"Retrieve daily activity for applicable users for a date range (/v2/stats/activity/day-by-day)","description":"Retrieve the daily activity of multiple users within the Gong system for a range of dates. This endpoint returns records including statistics about each user's activity, on the daily level. Records are returned only for users with activity in the range.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions:detailed'.","operationId":"listMultipleUsersDayByDayActivityUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"multipleUsersRequest","description":"multipleUsersRequest","required":true,"schema":{"$ref":"#/definitions/Request«MultipleUsersWithDates»","originalRef":"#/definitions/Request«MultipleUsersWithDates»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/UsersDayByDayActivity","originalRef":"#/definitions/UsersDayByDayActivity"},"schema":{"$ref":"#/definitions/UsersDayByDayActivity","originalRef":"#/definitions/UsersDayByDayActivity"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"User not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/stats/activity/scorecards":{"post":{"tags":["Stats"],"summary":"Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards)","description":"Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:scorecards'.","operationId":"listAnsweredScorecardsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"answeredScorecardsRequest","description":"answeredScorecardsRequest","required":true,"schema":{"$ref":"#/definitions/Request«AnsweredScorecardsFilter»","originalRef":"#/definitions/Request«AnsweredScorecardsFilter»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/AnsweredScorecards","originalRef":"#/definitions/AnsweredScorecards"},"schema":{"$ref":"#/definitions/AnsweredScorecards","originalRef":"#/definitions/AnsweredScorecards"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"Answered scorecards not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/stats/interaction":{"post":{"tags":["Stats"],"summary":"Retrieve interaction stats for applicable users by date (/v2/stats/interaction)","description":"Returns interaction stats for users based on calls that have Whisper turned on.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:interaction'.","operationId":"listInteractionStatsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"statsRequest","description":"statsRequest","required":true,"schema":{"$ref":"#/definitions/Request«MultipleUsersWithDates»","originalRef":"#/definitions/Request«MultipleUsersWithDates»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/CompanyUsersIntercationStatsResponse","originalRef":"#/definitions/CompanyUsersIntercationStatsResponse"},"schema":{"$ref":"#/definitions/CompanyUsersIntercationStatsResponse","originalRef":"#/definitions/CompanyUsersIntercationStatsResponse"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"No stats found for the specified period","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/users":{"get":{"tags":["Users"],"summary":"List all users (/v2/users)","description":"List all of the company's users.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.","operationId":"listUsersUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records.","required":false,"type":"string","x-example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM"},{"name":"includeAvatars","in":"query","description":"Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars' IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results.","required":false,"type":"boolean","x-example":"false"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/UsersMetadata","originalRef":"#/definitions/UsersMetadata"},"schema":{"$ref":"#/definitions/UsersMetadata","originalRef":"#/definitions/UsersMetadata"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"403":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/users/extensive":{"post":{"tags":["Users"],"summary":"List users by filter (/v2/users/extensive)","description":"List multiple Users.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.","operationId":"listMultipleUsersUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"multipleUsersRequest","description":"multipleUsersRequest","required":true,"schema":{"$ref":"#/definitions/Request«MultipleUsersRequestWithCreationDates»","originalRef":"#/definitions/Request«MultipleUsersRequestWithCreationDates»"}}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/UsersMetadata","originalRef":"#/definitions/UsersMetadata"},"schema":{"$ref":"#/definitions/UsersMetadata","originalRef":"#/definitions/UsersMetadata"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"User not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/users/{id}":{"get":{"tags":["Users"],"summary":"Retrieve user (/v2/users/{id})","description":"Retrieve a specific user.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.","operationId":"getUserUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Gong's unique numeric identifier for the user (up to 20 digits).","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/User","originalRef":"#/definitions/User"},"schema":{"$ref":"#/definitions/User","originalRef":"#/definitions/User"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"User not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/users/{id}/settings-history":{"get":{"tags":["Users"],"summary":"Retrieve user history (/v2/users/{id}/settings-history)","description":"Retrieve a specific user's history.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.","operationId":"getUserHistoryUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Gong's unique numeric identifier for the user (up to 20 digits).","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/SettingsHistory","originalRef":"#/definitions/SettingsHistory"},"schema":{"$ref":"#/definitions/SettingsHistory","originalRef":"#/definitions/SettingsHistory"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"401":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"404":{"description":"User not found","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}},"/v2/workspaces":{"get":{"tags":["Settings"],"summary":"List all company workspaces (/v2/workspaces)","description":"Returns a list of all workspaces including their details.\n\nWhen accessed through a Bearer token authorization method, this endpoint requires the scope 'api:workspaces:read'.","operationId":"listWorkspacesUsingGET","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Successful response","responseSchema":{"$ref":"#/definitions/WorkspacesMetadata","originalRef":"#/definitions/WorkspacesMetadata"},"schema":{"$ref":"#/definitions/WorkspacesMetadata","originalRef":"#/definitions/WorkspacesMetadata"}},"400":{"description":"Malformed request","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"403":{"description":"Access denied","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"429":{"description":"API request limit exceeded","headers":{"Retry-After":{"type":"integer","format":"int32"}},"responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}},"500":{"description":"Failed to complete the operation due to an unexpected error","responseSchema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"},"schema":{"$ref":"#/definitions/ErrorResponse","originalRef":"#/definitions/ErrorResponse"}}}}}},"definitions":{"Actor":{"type":"object","properties":{"context":{"type":"array","description":"A list of links to external systems such as CRM, Telephony System, Case Management, etc.","items":{"$ref":"#/definitions/PartyUploadContext","originalRef":"#/definitions/PartyUploadContext"}},"email":{"type":"string","example":"test@test.com","description":"The email address of the person, if available."},"name":{"type":"string","example":"Test User","description":"The name of the person, if available."},"title":{"type":"string","example":"Enterprise Account Executive","description":"The title of the person, if available."}},"title":"Actor"},"AggregateActivity":{"type":"object","properties":{"callsAsHost":{"type":"integer","format":"int32","example":20,"description":"The number of recorded calls this user hosted."},"callsAttended":{"type":"integer","format":"int32","example":46,"description":"The number of calls in which this user is participant (not host)."},"callsCommentsGiven":{"type":"integer","format":"int32","example":21,"description":"The number of calls in which a user gave at least one comment."},"callsCommentsReceived":{"type":"integer","format":"int32","example":13,"description":"The number of calls in which a user received at least one comment on the users calls."},"callsGaveFeedback":{"type":"integer","format":"int32","example":35,"description":"The number of recorded calls the user gave feedback on."},"callsMarkedAsFeedbackGiven":{"type":"integer","format":"int32","example":24,"description":"The number of calls in which someone pressed the \"Mark as reviewed\"."},"callsMarkedAsFeedbackReceived":{"type":"integer","format":"int32","example":35,"description":"The number of calls in which someone pressed the “Mark as reviewed” on the users calls."},"callsReceivedFeedback":{"type":"integer","format":"int32","example":67,"description":"The number of recorded calls the user received feedback on."},"callsRequestedFeedback":{"type":"integer","format":"int32","example":77,"description":"The number of recorded calls the user requested feedback on."},"callsScorecardsFilled":{"type":"integer","format":"int32","example":876,"description":"The number of scorecards the user completed."},"callsScorecardsReceived":{"type":"integer","format":"int32","example":876,"description":"The number of calls in which someone filled a scorecard on the user's calls."},"callsSharedExternally":{"type":"integer","format":"int32","example":75,"description":"The number of calls the user shared with others outside the company."},"callsSharedInternally":{"type":"integer","format":"int32","example":478,"description":"The number of calls the user shared with others inside the company."},"othersCallsListenedTo":{"type":"integer","format":"int32","example":96,"description":"The number of other users' calls the user listened to."},"ownCallsListenedTo":{"type":"integer","format":"int32","example":668,"description":"The number of the user's own calls the user listened to."}},"title":"AggregateActivity","description":"Aggregated activity for a user within a time period"},"AggregateActivityWithDates":{"type":"object","properties":{"callsAsHost":{"type":"integer","format":"int32","example":20,"description":"The number of recorded calls this user hosted."},"callsAttended":{"type":"integer","format":"int32","example":46,"description":"The number of calls in which this user is participant (not host)."},"callsCommentsGiven":{"type":"integer","format":"int32","example":21,"description":"The number of calls in which a user gave at least one comment."},"callsCommentsReceived":{"type":"integer","format":"int32","example":13,"description":"The number of calls in which a user received at least one comment on the users calls."},"callsGaveFeedback":{"type":"integer","format":"int32","example":35,"description":"The number of recorded calls the user gave feedback on."},"callsMarkedAsFeedbackGiven":{"type":"integer","format":"int32","example":24,"description":"The number of calls in which someone pressed the \"Mark as reviewed\"."},"callsMarkedAsFeedbackReceived":{"type":"integer","format":"int32","example":35,"description":"The number of calls in which someone pressed the “Mark as reviewed” on the users calls."},"callsReceivedFeedback":{"type":"integer","format":"int32","example":67,"description":"The number of recorded calls the user received feedback on."},"callsRequestedFeedback":{"type":"integer","format":"int32","example":77,"description":"The number of recorded calls the user requested feedback on."},"callsScorecardsFilled":{"type":"integer","format":"int32","example":876,"description":"The number of scorecards the user completed."},"callsScorecardsReceived":{"type":"integer","format":"int32","example":876,"description":"The number of calls in which someone filled a scorecard on the user's calls."},"callsSharedExternally":{"type":"integer","format":"int32","example":75,"description":"The number of calls the user shared with others outside the company."},"callsSharedInternally":{"type":"integer","format":"int32","example":478,"description":"The number of calls the user shared with others inside the company."},"fromDate":{"type":"string","example":"2019-01-20T00:00:00-08:00","description":"The start of the period, or the request filter's fromDate for the first period in the range, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"othersCallsListenedTo":{"type":"integer","format":"int32","example":96,"description":"The number of other users' calls the user listened to."},"ownCallsListenedTo":{"type":"integer","format":"int32","example":668,"description":"The number of the user's own calls the user listened to."},"toDate":{"type":"string","example":"2019-01-21T000:00:00-08:00","description":"The end of the period, or the request filter's toDate for the last period in the range,  in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."}},"title":"AggregateActivityWithDates","description":"Aggregated activity for a user within a time period"},"Answer":{"type":"object","properties":{"answerText":{"type":"string","example":"Done a great job. Scheduled a follow-up demo.","description":"The answer's text, if answered. Null otherwise."},"isOverall":{"type":"boolean","example":true,"description":"If the question is the main overall question or not."},"notApplicable":{"type":"boolean","example":false,"description":"If the question is irrelevant for the call."},"questionId":{"type":"string","example":"35657219295037524478","description":"The identifier of the question."},"questionRevisionId":{"type":"string","example":"43955224753211112","description":"The identifier of the revision version of the question."},"score":{"type":"integer","format":"int32","example":4,"description":"Score between 1 to 5, if answered. Null otherwise."}},"title":"Answer"},"AnsweredScorecard":{"type":"object","properties":{"answeredScorecardId":{"type":"string","example":"563515258458745","description":"The identifier of the answer of the scorecard."},"answers":{"type":"array","description":"The answers in the answered scorecard.","items":{"$ref":"#/definitions/Answer","originalRef":"#/definitions/Answer"}},"callId":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric identifier for the call (up to 20 digits)."},"callStartTime":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date and time when the call was recorded in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"reviewTime":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date and time when the review was completed and published in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"reviewedUserId":{"type":"string","example":"234599484848423","description":"The user Id of the team member being reviewed, who hosted the call."},"reviewerUserId":{"type":"string","example":"563515258458745","description":"The user Id of the team member who answered the scorecard for the call."},"scorecardId":{"type":"string","example":"6843152929075440037","description":"The identifier of the scorecard."},"scorecardName":{"type":"string","example":"SDR Call Scorecard","description":"Scorecard name."},"visibilityType":{"type":"string","enum":["OPT_IN_USERS","PRIVATE","PUBLIC"]}},"title":"AnsweredScorecard"},"AnsweredScorecards":{"type":"object","properties":{"answeredScorecards":{"type":"array","description":"A list, in which each item contains one answered scorecard.","items":{"$ref":"#/definitions/AnsweredScorecard","originalRef":"#/definitions/AnsweredScorecard"}},"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"AnsweredScorecards"},"AnsweredScorecardsFilter":{"type":"object","properties":{"callFromDate":{"type":"string","example":"2019-01-20","description":"The date (in the company's time zone) of the call from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest recorded call."},"callToDate":{"type":"string","example":"2019-01-25","description":"The date (in the company's time zone) of the call until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest recorded call."},"reviewFromDate":{"type":"string","example":"2019-01-20","description":"The review date (in the company's time zone) from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest reviewed call."},"reviewToDate":{"type":"string","example":"2019-01-25","description":"The review date (in the company's time zone) until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest reviewed call."},"reviewedUserIds":{"type":"object","example":["234599484848423"],"description":"List of user Ids of the team members being reviewed. If not specified, it returns all answered scorecards in the corresponding filter.","properties":{}},"scorecardIds":{"type":"object","example":["6843152929075440037"],"description":"List of scorecards Ids. If not specified, it returns all answered scorecards in the corresponding filter.","properties":{}}},"title":"AnsweredScorecardsFilter","description":"Filter parameters."},"AssociationObject":{"type":"object","properties":{"accountCrmId":{"type":"string","example":"a5V1Q00A120DP4CVAW","description":"CRM account Id."},"dealCrmId":{"type":"string","example":"0052Q00000qkGmgQBT","description":"CRM deal Id, if deal/opportunity was associated."}},"title":"AssociationObject"},"AsyncProcessingResponse":{"type":"object","properties":{"clientRequestId":{"type":"string","example":"clientRequest1","description":"The clientRequestId sent in the request - used to monitor the request process"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"AsyncProcessingResponse"},"BaseResponse":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"BaseResponse"},"Call":{"type":"object","properties":{"collaboration":{"$ref":"#/definitions/Collaboration","originalRef":"#/definitions/Collaboration"},"content":{"$ref":"#/definitions/Content","originalRef":"#/definitions/Content"},"context":{"type":"array","description":"A list of links to external systems such as CRM, Dialer, Case Management, etc.","items":{"$ref":"#/definitions/CallContext","originalRef":"#/definitions/CallContext"}},"interaction":{"$ref":"#/definitions/Interaction","originalRef":"#/definitions/Interaction"},"media":{"$ref":"#/definitions/Media","originalRef":"#/definitions/Media"},"metaData":{"$ref":"#/definitions/CallBasicData","originalRef":"#/definitions/CallBasicData"},"parties":{"type":"array","description":"A list of the call's participants","items":{"$ref":"#/definitions/Party","originalRef":"#/definitions/Party"}}},"title":"Call","description":"Represent a call data"},"CallAccessDetails":{"type":"object","properties":{"callId":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric call ID."},"users":{"type":"array","description":"A list of users having access.","items":{"$ref":"#/definitions/UserAccessDetails","originalRef":"#/definitions/UserAccessDetails"}}},"title":"CallAccessDetails","description":"Call access details"},"CallAccessWithPermissionLevel":{"type":"object","properties":{"permissionLevel":{"type":"string","description":"Permission access scope.","enum":["all / managers-team / report-to-them / own / none"]},"teamLeadIds":{"type":"array","example":["295738305212375930"],"description":"List of user IDs to populate the managers-team permission level\n\nYou can retrieve the user ids by using the “Users” API.","uniqueItems":true,"items":{"type":"string"}}},"title":"CallAccessWithPermissionLevel","description":"Calls access permission."},"CallBasicData":{"type":"object","properties":{"clientUniqueId":{"type":"string","example":"7JEHFRGXDDZFEW2FC4U","description":"The call's unique identifier in the origin recording system (typically a telephony recording system). The identifier is provided to Gong during the call creation via the Public API or through telephony systems integrations."},"customData":{"type":"string","example":"Conference Call","description":"Metadata as was provided to Gong during the call creation via the Public API."},"direction":{"type":"string","description":"Call direction.","enum":["Conference","Inbound","Outbound","Unknown"]},"duration":{"type":"integer","format":"int64","example":460,"description":"The duration of the call, in seconds."},"id":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric identifier for the call (up to 20 digits)."},"isPrivate":{"type":"boolean","example":false,"description":"If the call is private."},"language":{"type":"string","example":"eng","description":"The language codes (as defined by ISO-639-2B). E.g., eng, fre, spa, ger, and ita. Also used are und (unsupported language), and zxx (not enough speech content for identification)."},"media":{"type":"string","example":"Video","description":"Media type","enum":["Audio","Video"]},"meetingUrl":{"type":"string","example":"https://zoom.us/j/123","description":"The meeting provider URL on which the web conference was recorded."},"primaryUserId":{"type":"string","example":"234599484848423","description":"The primary user ID of the team member who hosted the call."},"purpose":{"type":"string","example":"Demo Call","description":"The purpose of the call."},"scheduled":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"Scheduled date and time of the call in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"scope":{"type":"string","example":"Internal","description":"The scope of the call: 'internal' if all the participants are from the company, 'external' if some participants are not from the company, or 'unknown' if the scope is unknown.","enum":["External","Internal","Unknown"]},"sdrDisposition":{"type":"string","example":"Got the gatekeeper","description":"The SDR disposition of the call"},"started":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date and time when the call was recorded in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"system":{"type":"string","example":"Outreach","description":"The system with which the call was carried out (e.g., WebEx, ShoreTel, etc.)."},"title":{"type":"string","example":"Example call","description":"The title of the call."},"url":{"type":"string","example":"https://app.gong.io/call?id=7782342274025937895","description":"The URL to the page in the Gong web application where the call is available."},"workspaceId":{"type":"string","example":"623457276584334","description":"Gong's unique numeric identifier for the call's workspace (up to 20 digits)."}},"title":"CallBasicData","description":"Basic details such as call date, title, call URL, etc."},"CallCollaboration":{"type":"object","properties":{"publicComments":{"type":"boolean","example":true,"description":"If true, add public comments made for this call"}},"title":"CallCollaboration","description":"Call collaboration"},"CallContent":{"type":"object","properties":{"pointsOfInterest":{"type":"boolean","example":false,"description":"If true, add call points of interest"},"structure":{"type":"boolean","example":false,"description":"If true, add call agenda, if available"},"topics":{"type":"boolean","example":false,"description":"If true, add duration of call topics"},"trackerOccurrences":{"type":"boolean","example":false,"description":"If true, the API will return the timing and speaker ID of each occurrence of a tracker (in addition to other tracker data). This functionality must be used in combination with the \"trackers\" field. The occurrence data is available only for the calls recorded since Jan 1, 2023, contact Gong support if a backfill of this data is required."},"trackers":{"type":"boolean","example":false,"description":"If true, returns smart tracker and keyword tracker information for the call."}},"title":"CallContent","description":"The content of the call"},"CallContext":{"type":"object","properties":{"objects":{"type":"array","description":"List of objects within the external system","items":{"$ref":"#/definitions/ExternalCallObject","originalRef":"#/definitions/ExternalCallObject"}},"system":{"type":"string","example":"Salesforce","description":"External system name. e.g. Salesforce","enum":["Generic","HubSpot","MicrosoftDynamic","Salesforce"]}},"title":"CallContext","description":"Links to external systems such as CRM, Dialer, Case Management etc"},"CallInteraction":{"type":"object","properties":{"personInteractionStats":{"type":"boolean","example":true,"description":"If true, add statistics for the host of the call."},"questions":{"type":"boolean","example":true,"description":"If true, add question counts"},"speakers":{"type":"boolean","example":true,"description":"If true, add the time each participant spoke."},"video":{"type":"boolean","example":true,"description":"If true, add video statistics"}},"title":"CallInteraction","description":"The interaction data of the call"},"CallParticipant":{"type":"object","properties":{"context":{"type":"array","description":"A list of links to external systems such as CRM, Telephony System, Case Management, etc.","items":{"$ref":"#/definitions/PartyUploadContext","originalRef":"#/definitions/PartyUploadContext"}},"emailAddress":{"type":"string","example":"test@test.com","description":"The email address of the party, if available."},"mediaChannelId":{"type":"integer","format":"int32","example":0,"description":"The audio channel corresponding to the company team member (rep) used when the uploaded media file is multi-channel (stereo). The channel id is either 0 or 1 (representing left or right respectively)"},"name":{"type":"string","example":"Test User","description":"The name of the party, if available."},"partyId":{"type":"string","example":"1","description":"An identifier that is only required when speakersTimeline is provided.\n The partyId is used to recognize the speakers within the provided speakersTimeline."},"phoneNumber":{"type":"string","example":"+1 123-567-8989","description":"The phone number of the party, if available."},"userId":{"type":"string","example":"234599484848423","description":"The user ID of the participant within the Gong system, if the participant is a user."}},"title":"CallParticipant"},"CallReference":{"type":"object","properties":{"externalSystems":{"type":"array","description":"A list of links to external systems such as CRM, Telephony System, Case Management, etc.","items":{"$ref":"#/definitions/ExternalSystem","originalRef":"#/definitions/ExternalSystem"}},"id":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric identifier for the call (up to 20 digits)."},"status":{"type":"string","example":"COMPLETED","description":"Call status"}},"title":"CallReference","description":"Details of a call referencing the email address."},"CallTranscript":{"type":"object","properties":{"callId":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric identifier for the call (up to 20 digits)."},"transcript":{"type":"array","description":"List of monologues.","items":{"$ref":"#/definitions/Monologue","originalRef":"#/definitions/Monologue"}}},"title":"CallTranscript"},"CallTranscripts":{"type":"object","properties":{"callTranscripts":{"type":"array","description":"A list with one entry per call.","items":{"$ref":"#/definitions/CallTranscript","originalRef":"#/definitions/CallTranscript"}},"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"CallTranscripts"},"CallUploadContext":{"type":"object","required":["system"],"properties":{"objects":{"type":"array","description":"List of objects within the external system. Note: Multiple opportunities/deals belonging to the same account are not supported.","items":{"$ref":"#/definitions/ExternalCrmCallObject","originalRef":"#/definitions/ExternalCrmCallObject"}},"system":{"type":"string","example":"Salesforce","description":"External system name. Currently only Salesforce and Generic are supported.","enum":["Salesforce"]}},"title":"CallUploadContext","description":"Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported."},"CallUsersAccessDto":{"type":"object","required":["callId","userIds"],"properties":{"callId":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric call ID."},"userIds":{"type":"object","example":["234599484848423"],"description":"Array of Gong's unique numeric user IDs.","properties":{}}},"title":"CallUsersAccessDto","description":"Call users access"},"Calls":{"type":"object","properties":{"calls":{"type":"array","description":"A list with one entry per call.","items":{"$ref":"#/definitions/Call","originalRef":"#/definitions/Call"}},"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"Calls"},"CallsAccessDetailsResponse":{"type":"object","properties":{"callAccessList":{"type":"array","description":"A list, in which each item specifies a call & users with access to this call.","items":{"$ref":"#/definitions/CallAccessDetails","originalRef":"#/definitions/CallAccessDetails"}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"CallsAccessDetailsResponse"},"CallsAccessGetDto":{"type":"object","required":["callIds"],"properties":{"callIds":{"type":"object","example":["7782342274025937895"],"description":"Array of Gong's unique numeric call IDs.","properties":{}}},"title":"CallsAccessGetDto"},"CallsFilter":{"type":"object","properties":{"callIds":{"type":"object","example":["7782342274025937895"],"description":"List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime.","properties":{}},"fromDateTime":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date from which to list calls, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the calls start with the earliest recorded call. The date applies to call start time."},"toDateTime":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"The date until which to list calls, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the calls end with the latest recorded call. The date applies to call start time."},"workspaceId":{"type":"string","example":"623457276584334","description":"Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace."}},"title":"CallsFilter","description":"Filter parameters."},"CallsRequestFilterWithOwners":{"type":"object","properties":{"callIds":{"type":"object","example":["7782342274025937895"],"description":"List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime.","properties":{}},"fromDateTime":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date from which to list calls, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the calls start with the earliest recorded call. The date applies to call start time."},"primaryUserIds":{"type":"object","example":["7782342274025937895"],"description":"An optional list of user identifiers, if supplied the API will return only the calls hosted by the specified users. The identifiers in this field match the primaryUserId field of the calls.","properties":{}},"toDateTime":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"The date until which to list calls, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the calls end with the latest recorded call. The date applies to call start time."},"workspaceId":{"type":"string","example":"623457276584334","description":"Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace."}},"title":"CallsRequestFilterWithOwners","description":"Filter parameters."},"CallsResponse":{"type":"object","properties":{"calls":{"type":"array","description":"A list, in which each item specifies one call.","items":{"$ref":"#/definitions/CallBasicData","originalRef":"#/definitions/CallBasicData"}},"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"CallsResponse"},"CallsUsersAccessAddDto":{"type":"object","properties":{"callAccessList":{"type":"array","description":"A list, in which each item specifies a call and a list of users to be given access to this call.","items":{"$ref":"#/definitions/CallUsersAccessDto","originalRef":"#/definitions/CallUsersAccessDto"}}},"title":"CallsUsersAccessAddDto"},"CallsUsersAccessDeleteDto":{"type":"object","properties":{"callAccessList":{"type":"array","description":"A list, in which each item specifies a call and a list of users to be removed from the call.","items":{"$ref":"#/definitions/CallUsersAccessDto","originalRef":"#/definitions/CallUsersAccessDto"}}},"title":"CallsUsersAccessDeleteDto"},"CoachingAccessWithPermissionLevel":{"type":"object","properties":{"permissionLevel":{"type":"string","description":"Permission access scope.","enum":["all / managers-team / report-to-them / own / none"]},"teamLeadIds":{"type":"array","example":["295738305212375930"],"description":"List of user IDs to populate the managers-team permission level\n\nYou can retrieve the user ids by using the “Users” API.","uniqueItems":true,"items":{"type":"string"}}},"title":"CoachingAccessWithPermissionLevel","description":"Coaching access permission."},"Collaboration":{"type":"object","properties":{"publicComments":{"type":"array","description":"A list of public comments.","items":{"$ref":"#/definitions/Comment","originalRef":"#/definitions/Comment"}}},"title":"Collaboration","description":"Collaboration information added to the call"},"Comment":{"type":"object","properties":{"audioEndTime":{"type":"number","format":"float","example":26.0,"description":"The number of seconds from the beginning of the call that the comment ends refers to."},"audioStartTime":{"type":"number","format":"float","example":26.0,"description":"The number of seconds from the beginning of the call that the comment start refers to."},"comment":{"type":"string","example":"new comment","description":"The comment itself. The comment may contains person tagging in this format @[user name](user Id)"},"commenterUserId":{"type":"string","example":"234599484848423","description":"Unique identifier of the user who wrote the comment."},"duringCall":{"type":"boolean","description":"True if the comment was written during the call, false if it was posted after the call."},"id":{"type":"string","example":"6843152929075440037","description":"Unique identifier of the comment within the Gong's system."},"inReplyTo":{"type":"string","example":"792390015966656336","description":"The unique identifier of the original comment in case the current comment is a reply to the original one."},"posted":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); in which the comment was posted."}},"title":"Comment"},"CompanyUsersAggregateActivityResponse":{"type":"object","properties":{"fromDateTime":{"type":"string","example":"2019-01-20T00:00:00-08:00","description":"The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC), when the list of results starts."},"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"timeZone":{"type":"string","example":"US/Pacific","description":"The company's defined timezone in Gong."},"toDateTime":{"type":"string","example":"2019-01-21T000:00:00-08:00","description":"The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC), when the list of results ends."},"usersAggregateActivityStats":{"type":"array","description":"A list, in which each item specifies one user's activities.","items":{"$ref":"#/definitions/UserActivity","originalRef":"#/definitions/UserActivity"}}},"title":"CompanyUsersAggregateActivityResponse"},"CompanyUsersIntercationStatsResponse":{"type":"object","properties":{"fromDateTime":{"type":"string","example":"2019-01-20T00:00:00-08:00","description":"The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC), when the list of results starts."},"peopleInteractionStats":{"type":"array","description":"A list of interaction statistics. Applicable values: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience', 'Question Rate'.","items":{"$ref":"#/definitions/InteractionStats","originalRef":"#/definitions/InteractionStats"}},"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"timeZone":{"type":"string","example":"US/Pacific","description":"The company's defined timezone in Gong."},"toDateTime":{"type":"string","example":"2019-01-21T000:00:00-08:00","description":"The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC), when the list of results ends."}},"title":"CompanyUsersIntercationStatsResponse"},"Content":{"type":"object","properties":{"pointsOfInterest":{"description":" Points of interest of the call.","$ref":"#/definitions/PointsOfInterest","originalRef":"#/definitions/PointsOfInterest"},"structure":{"type":"array","description":"A list of the agenda of each part of the call.","items":{"$ref":"#/definitions/Structure","originalRef":"#/definitions/Structure"}},"topics":{"type":"array","description":" A list of topics and their durations.","items":{"$ref":"#/definitions/topic","originalRef":"#/definitions/topic"}},"trackers":{"type":"array","description":"A list of trackers found in the call. Trackers are collections of phrases defined in Gong for this company.","items":{"$ref":"#/definitions/tracker","originalRef":"#/definitions/tracker"}}},"title":"Content","description":"Analysis of the interaction content."},"ContentSelector":{"type":"object","properties":{"context":{"type":"string","description":"If 'Basic', add links to external systems (context objects) such as CRM, Telephony System, Case Management. If 'Extended' include also data (context fields) for these links. Default value 'None'","enum":["Basic","Extended","None"]},"contextTiming":{"type":"array","description":"Timing for the context data. The field is optional and can contain either \"Now\" or \"TimeOfCall\" or both. The default value is [\"Now\"]. Can be provided only when the context field is set to 'Extended'","items":{"type":"string","enum":["Now","TimeOfCall"]}},"exposedFields":{"$ref":"#/definitions/ExposedFields","originalRef":"#/definitions/ExposedFields"}},"title":"ContentSelector","description":"The content selector identifies which data components, if any, are needed, by the caller"},"ContentSharedEvent":{"type":"object","required":["contentId","contentTitle","contentUrl","eventTimestamp","reportingSystem"],"properties":{"actionName":{"type":"string","example":"My Title","description":"The name of the action like \"Document Sent\" or \"Presentation Shared\"."},"contentId":{"type":"string","example":"doc_123456789","description":"The id of the content that was shared in the reporting system."},"contentProperties":{"type":"array","description":"A list of additional properties for the content","items":{"$ref":"#/definitions/Generic Property","originalRef":"#/definitions/Generic Property"}},"contentTitle":{"type":"string","example":"Features & Spec V.1","description":"Human readable title of the content."},"contentUrl":{"type":"string","example":"https://example.com/doc_123456789","description":"The url of the content that was shared in the reporting system. This is the url that is was accessed by the viewer."},"crmContext":{"type":"array","description":"A list of references to external systems such as CRM, Telephony System, Case Management, etc.","items":{"$ref":"#/definitions/CallUploadContext","originalRef":"#/definitions/CallUploadContext"}},"eventId":{"type":"string","example":"abc123","description":"The original id of the event as designated in the reporting system."},"eventProperties":{"type":"array","description":"A list of additional properties for the event","items":{"$ref":"#/definitions/Generic Property","originalRef":"#/definitions/Generic Property"}},"eventTimestamp":{"type":"string","example":"2021-02-17T02:30:00-08:00","description":"The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC);"},"recipients":{"type":"array","description":"array of objects with  name + email of recipients. Email is required.","items":{"$ref":"#/definitions/Actor","originalRef":"#/definitions/Actor"}},"reportingSystem":{"type":"string","example":"abc123","description":"The unique identifier of the reporting system. It is the same value in all events originating from the same system."},"shareId":{"type":"string","example":"abc123","description":"The id of the share action, in case there can be more than one share per content."},"shareInfoUrl":{"type":"string","example":"https://example.com/path/to/a/page","description":"The link to a page that presents additional information about this event."},"sharer":{"description":"The object that describes the person who shared the content: email, name and user id in Gong. All properties are optional.","$ref":"#/definitions/Sharer","originalRef":"#/definitions/Sharer"},"sharingMessageBody":{"type":"string","example":"<b>Hi</b>","description":"The share message body. Can contain HTML and will be cleaned when it is presented."},"sharingMessageSubject":{"type":"string","example":"Sample Subject","description":"The subject of share email / message."},"workspaceId":{"type":"string","example":"623457276584334","description":"Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied."}},"title":"ContentSharedEvent","description":"Content Shared Event"},"ContentViewedEvent":{"type":"object","required":["contentId","contentTitle","contentUrl","eventTimestamp","reportingSystem"],"properties":{"agentPlatform":{"type":"string","description":"Platform on which the interaction was made","enum":["Android","Linux","MacOS","Windows","iOS"]},"contentId":{"type":"string","example":"doc_123456789","description":"The id of the content that was viewed in the reporting system."},"contentProperties":{"type":"array","description":"A list of additional properties for the content","items":{"$ref":"#/definitions/Generic Property","originalRef":"#/definitions/Generic Property"}},"contentTitle":{"type":"string","example":"Features & Spec V.1","description":"Human readable title of the content."},"contentUrl":{"type":"string","example":"https://example.com/doc_123456789","description":"The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer."},"crmContext":{"type":"array","description":"A list of references to external systems such as CRM, Telephony System, Case Management, etc.","items":{"$ref":"#/definitions/CallUploadContext","originalRef":"#/definitions/CallUploadContext"}},"eventId":{"type":"string","example":"abc123","description":"The original id of the event as designated in the reporting system."},"eventProperties":{"type":"array","description":"A list of additional properties for the event","items":{"$ref":"#/definitions/Generic Property","originalRef":"#/definitions/Generic Property"}},"eventTimestamp":{"type":"string","example":"2021-02-17T02:30:00-08:00","description":"The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC);"},"mobileAppId":{"type":"string","description":"The application identification string in case of interaction via mobile application (bundle identifier or package name)."},"reportingSystem":{"type":"string","example":"abc123","description":"The unique identifier of the reporting system. It is the same value in all events originating from the same system."},"shareId":{"type":"string","example":"abc123","description":"The id of the share action that corresponds to this view event, in case there can be more than one share per content."},"userAgent":{"type":"string","description":"\"User-Agent\" header value for browser based interaction"},"viewActionTitle":{"type":"string","example":"My Title","description":"The name of the action like \"Document Viewed\" or \"Presentation Opened\"."},"viewInfoUrl":{"type":"string","example":"https://example.com/path/to/a/page","description":"The link to a page that presents additional information about this event."},"viewer":{"description":"The object that describes the viewer. Viewer with an email is required if crmContext was not provided or lacks info about an account.","$ref":"#/definitions/Actor","originalRef":"#/definitions/Actor"},"workspaceId":{"type":"string","example":"623457276584334","description":"Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied."}},"title":"ContentViewedEvent","description":"Content Viewed event"},"ContextField":{"type":"object","properties":{"name":{"type":"string","example":"name","description":"Field name. For Account supported fields are: Name, Website, Industry and all the custom fields. For Opportunity supported fields are Name, LeadSource, Type, StageName, Probability, Amount, CloseDate and all the custom fields."},"value":{"type":"object","example":"Gong Inc.","description":"Field value","properties":{}}},"title":"ContextField","description":"External object data"},"CrmPartyContextField":{"type":"object","properties":{"name":{"type":"string","example":"name","description":"Field name"},"value":{"type":"object","example":"Gong Inc.","description":"Object value","properties":{}}},"title":"CrmPartyContextField","description":"External object data"},"CustomActionEvent":{"type":"object","required":["eventTimestamp","reportingSystem"],"properties":{"actionName":{"type":"string","example":"My Title","description":"The name of the action like \"Document Viewed\" or \"Presentation Opened\"."},"actor":{"description":"The object that describes the person that performed the interaction. An email is required if crmContext was not provided or lacks info about an account.","$ref":"#/definitions/Actor","originalRef":"#/definitions/Actor"},"agentPlatform":{"type":"string","description":"Platform on which the interaction was made","enum":["Android","Linux","MacOS","Windows","iOS"]},"contentId":{"type":"string","example":"doc_123456789","description":"The id of the content that was viewed in the reporting system."},"contentProperties":{"type":"array","description":"A list of additional properties for the content","items":{"$ref":"#/definitions/Generic Property","originalRef":"#/definitions/Generic Property"}},"contentTitle":{"type":"string","example":"Features & Spec V.1","description":"Human readable title of the content."},"contentUrl":{"type":"string","example":"https://example.com/doc_123456789","description":"The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer."},"crmContext":{"type":"array","description":"A list of references to external systems such as CRM, Telephony System, Case Management, etc.","items":{"$ref":"#/definitions/CallUploadContext","originalRef":"#/definitions/CallUploadContext"}},"eventId":{"type":"string","example":"abc123","description":"The original id of the event as designated in the reporting system."},"eventInfoUrl":{"type":"string","example":"https://example.com/path/to/a/page","description":"The link to a page that presents additional information about this event."},"eventProperties":{"type":"array","description":"A list of additional properties for the event","items":{"$ref":"#/definitions/Generic Property","originalRef":"#/definitions/Generic Property"}},"eventTimestamp":{"type":"string","example":"2021-02-17T02:30:00-08:00","description":"The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC);"},"mobileAppId":{"type":"string","description":"The application identification string in case of interaction via mobile application (bundle identifier or package name)."},"reportingSystem":{"type":"string","example":"abc123","description":"The unique identifier of the reporting system. It is the same value in all events originating from the same system."},"userAgent":{"type":"string","description":"\"User-Agent\" header value for browser based interaction"},"workspaceId":{"type":"string","example":"623457276584334","description":"Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied."}},"title":"CustomActionEvent","description":"Custom Action Event"},"CustomerData":{"type":"object","properties":{"objects":{"type":"array","description":"List of objects in the external system.","items":{"$ref":"#/definitions/CustomerDataObject","originalRef":"#/definitions/CustomerDataObject"}},"system":{"type":"string","example":"Salesforce","description":"External system name.","enum":["Generic","HubSpot","MicrosoftDynamic","Salesforce"]}},"title":"CustomerData"},"CustomerDataObject":{"type":"object","properties":{"externalId":{"type":"string","example":"0013601230sV7grAAC","description":"External ID."},"fields":{"type":"array","description":"Object fields.","items":{"$ref":"#/definitions/ContextField","originalRef":"#/definitions/ContextField"}},"id":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric identifier (up to 20 digits) for the Lead or Contact."},"mirrorId":{"type":"string","example":"{\\\"integrationId\\\":\\\"262834820328732\\\",\\\"crmObjectType\\\":\\\"CONTACT\\\",\\\"crmId\\\":\\\"0031Q00002DFhi4QAD\\\"}","description":"Crm Mirror ID."},"objectType":{"type":"string","example":"Contact","description":"Object Type.","enum":["Contact","Lead"]}},"title":"CustomerDataObject"},"CustomerEngagement":{"type":"object","properties":{"contentId":{"type":"string","example":"7782342274025937895","description":"Event content id"},"contentUrl":{"type":"string","example":"https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i","description":"Event content url"},"eventName":{"type":"string","example":"https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i","description":"Event name"},"eventType":{"type":"string","example":"ExternalCallViewing","description":"Event type","enum":["contentShared","contentViewed","customEvent"]},"reportingSystem":{"type":"string","example":"https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i","description":"Event reporting system"},"sourceEventId":{"type":"string","example":"https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i","description":"Source event Id "},"timestamp":{"type":"string","example":"2019-01-20T00:00:00-08:00","description":"The date and time the event occurred in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."}},"title":"CustomerEngagement"},"DailyActivityWithDates":{"type":"object","properties":{"callsAsHost":{"type":"object","example":[348056639626337006],"description":"List of IDs of calls in which this user is the host.","properties":{}},"callsAttended":{"type":"object","example":[45783962636582],"description":"List of IDs of calls in which this user is participant (not host)","properties":{}},"callsCommentsGiven":{"type":"object","example":[45663345636581],"description":"List of IDs of calls in which a user gave at least one comment.","properties":{}},"callsCommentsReceived":{"type":"object","example":[45663962636582],"description":"List of IDs of calls in which a user received at least one comment on the users calls.","properties":{}},"callsGaveFeedback":{"type":"object","example":[5580564522626337006],"description":"List of IDs of calls where the user gave feedback.","properties":{}},"callsMarkedAsFeedbackGiven":{"type":"object","example":[45663962636581],"description":" List of IDs of calls in which someone pressed the \"Mark as reviewed\".","properties":{}},"callsMarkedAsFeedbackReceived":{"type":"object","example":[45663388836581],"description":"List of IDs of calls in which someone pressed the \"Mark as reviewed\" on the users calls.","properties":{}},"callsReceivedFeedback":{"type":"object","example":[342556337006],"description":" List of IDs of calls where the user received feedback.","properties":{}},"callsRequestedFeedback":{"type":"object","example":[342556337006],"description":" List of IDs of calls where the user requested feedback.","properties":{}},"callsScorecardsFilled":{"type":"object","example":[45663962636582],"description":"List of IDs of calls in which the user filled scorecards.","properties":{}},"callsScorecardsReceived":{"type":"object","example":[45663962636581],"description":"List of IDs of calls in which someone filled a scorecard on the users calls.","properties":{}},"callsSharedExternally":{"type":"object","example":[4563962633756],"description":"List of IDs of calls the user shared with people outside the company.","properties":{}},"callsSharedInternally":{"type":"object","example":[37555663966526337006],"description":"List of IDs of calls the user shared with other users inside the company.","properties":{}},"fromDate":{"type":"string","example":"2019-01-20T00:00:00-08:00","description":"The start of the day in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"othersCallsListenedTo":{"type":"object","example":[56305663962633755],"description":"List of IDs of calls, not belonging to this user, that the user listened to.","properties":{}},"ownCallsListenedTo":{"type":"object","example":[4553256639626337006],"description":"List of IDs of the user's own calls, that the user listened to.","properties":{}},"toDate":{"type":"string","example":"2019-01-21T000:00:00-08:00","description":"The end of the day in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."}},"title":"DailyActivityWithDates","description":"User daily activity"},"DealsAccessWithPermissionLevel":{"type":"object","properties":{"permissionLevel":{"type":"string","description":"Permission access scope.","enum":["all / managers-team / report-to-them / own / none"]},"teamLeadIds":{"type":"array","example":["295738305212375930"],"description":"List of user IDs to populate the managers-team permission level\n\nYou can retrieve the user ids by using the “Users” API.","uniqueItems":true,"items":{"type":"string"}}},"title":"DealsAccessWithPermissionLevel","description":"Deals access permission."},"DeleteMeetingRequest":{"type":"object","properties":{"organizerEmail":{"type":"string","example":"test@test.com","description":"The email address of the user who created the meeting."}},"title":"DeleteMeetingRequest","description":"Meeting update metadata"},"EmailAddressReferences":{"type":"object","properties":{"calls":{"type":"array","description":"Related calls.","items":{"$ref":"#/definitions/CallReference","originalRef":"#/definitions/CallReference"}},"customerData":{"type":"array","description":"A list of links to data from external systems (such as CRM, Telephony System, Case Management, etc.) that reference the email address and that Gong stores.","items":{"$ref":"#/definitions/CustomerData","originalRef":"#/definitions/CustomerData"}},"customerEngagement":{"type":"array","description":"A list of customer's engagement (such as viewing external share call)","items":{"$ref":"#/definitions/CustomerEngagement","originalRef":"#/definitions/CustomerEngagement"}},"emails":{"type":"array","description":"Related email messages.","items":{"$ref":"#/definitions/EmailMessage","originalRef":"#/definitions/EmailMessage"}},"meetings":{"type":"array","description":"Related meetings.","items":{"$ref":"#/definitions/Meeting","originalRef":"#/definitions/Meeting"}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"EmailAddressReferences"},"EmailMessage":{"type":"object","properties":{"from":{"type":"string","example":"test@test.com","description":"The sender's email address."},"id":{"type":"string","example":"223mjfaaqqjuegabiyrmpctvcwwl75oz","description":"Gong's unique 32 character identifier for the email message."},"mailbox":{"type":"string","example":"test@test.com","description":"The mailbox from which the email was retrieved."},"messageHash":{"type":"string","example":"l3z7w2s7oircdabnkwizmycm6g2uwznc","description":"Hash code of the email message."},"sentTime":{"type":"string","example":"2019-01-20T00:00:00-08:00","description":"The date and time the email message was sent in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."}},"title":"EmailMessage"},"EmailsAccessWithPermissionLevel":{"type":"object","properties":{"permissionLevel":{"type":"string","description":"Permission access scope.","enum":["all / managers-team / report-to-them / own / none"]},"teamLeadIds":{"type":"array","example":["295738305212375930"],"description":"List of user IDs to populate the managers-team permission level\n\nYou can retrieve the user ids by using the “Users” API.","uniqueItems":true,"items":{"type":"string"}}},"title":"EmailsAccessWithPermissionLevel","description":"Emails access permission."},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"object","example":["An error has occurred"],"description":"Error messages.","properties":{}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"ErrorResponse"},"EventAcceptedResponse":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"EventAcceptedResponse"},"ExposedFields":{"type":"object","properties":{"collaboration":{"$ref":"#/definitions/CallCollaboration","originalRef":"#/definitions/CallCollaboration"},"content":{"$ref":"#/definitions/CallContent","originalRef":"#/definitions/CallContent"},"interaction":{"$ref":"#/definitions/CallInteraction","originalRef":"#/definitions/CallInteraction"},"media":{"type":"boolean","example":true,"description":"If true and exist, add audio url and video url of the call. The urls will be available for 8 hours."},"parties":{"type":"boolean","example":true,"description":"If true, add information about the parties of the call"}},"title":"ExposedFields","description":"The exposed fields identifies which field, if any, are returned in the response object"},"ExternalCallObject":{"type":"object","properties":{"fields":{"type":"array","description":"Object fields","items":{"$ref":"#/definitions/ContextField","originalRef":"#/definitions/ContextField"}},"objectId":{"type":"string","example":"0013601230sV7grAAC","description":"Object ID"},"objectType":{"type":"string","example":"Opportunity","description":"Object Type. e.g Opportunity.","enum":["Account","Opportunity"]},"timing":{"type":"string","description":"Timing of object","enum":["Now","TimeOfCall"]}},"title":"ExternalCallObject","description":"External Object"},"ExternalCrmCallObject":{"type":"object","required":["objectId","objectType"],"properties":{"fields":{"type":"array","description":"Object fields. Intended for future use only.","items":{"$ref":"#/definitions/ContextField","originalRef":"#/definitions/ContextField"}},"objectId":{"type":"string","example":"0013601230sV7grAAC","description":"Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported."},"objectType":{"type":"string","example":"Account","description":"Object Type. e.g. Account.","enum":["Account","Opportunity"]}},"title":"ExternalCrmCallObject","description":"External object associated with the call"},"ExternalCrmPartyObject":{"type":"object","required":["objectId","objectType"],"properties":{"fields":{"type":"array","description":"Object fields. Intended for future use only.","items":{"$ref":"#/definitions/CrmPartyContextField","originalRef":"#/definitions/CrmPartyContextField"}},"objectId":{"type":"string","example":"0013601230sV7grAAC","description":"Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported."},"objectType":{"type":"string","example":"Contact","description":"Object Type. Valid only for non-company parties. e.g. Lead.","enum":["Contact","Lead"]}},"title":"ExternalCrmPartyObject","description":"External object associated with the party"},"ExternalPartyObject":{"type":"object","properties":{"fields":{"type":"array","description":"Object fields","items":{"$ref":"#/definitions/PartyContextField","originalRef":"#/definitions/PartyContextField"}},"objectId":{"type":"string","example":"0013601230sV7grAAC","description":"Object ID"},"objectType":{"type":"string","example":"Contact","description":"Object Type. e.g. Lead","enum":["Contact","Lead","User"]},"timing":{"type":"string","description":"Timing of object","enum":["Now","TimeOfCall"]}},"title":"ExternalPartyObject","description":"External Object"},"ExternalSystem":{"type":"object","properties":{"objects":{"type":"array","description":"List of objects within the external system.","items":{"$ref":"#/definitions/ExternalSystemObject","originalRef":"#/definitions/ExternalSystemObject"}},"system":{"type":"string","example":"Salesforce","description":"External system name.","enum":["Generic","HubSpot","MicrosoftDynamic","Salesforce"]}},"title":"ExternalSystem"},"ExternalSystemObject":{"type":"object","properties":{"externalId":{"type":"string","example":"0013601230sV7grAAC","description":"External ID."},"objectType":{"type":"string","example":"Task","description":"Object Type.","enum":["Conversation","Task"]}},"title":"ExternalSystemObject"},"ForecastAccessWithPermissionLevel":{"type":"object","properties":{"permissionLevel":{"type":"string","description":"Permission access scope.","enum":["all / managers-team / report-to-them / own / none"]},"teamLeadIds":{"type":"array","example":["295738305212375930"],"description":"List of user IDs to populate the managers-team permission level\n\nYou can retrieve the user ids by using the “Users” API.","uniqueItems":true,"items":{"type":"string"}}},"title":"ForecastAccessWithPermissionLevel","description":"Forecast access permission."},"Generic Property":{"type":"object","required":["dataType","name","value"],"properties":{"dataType":{"type":"string","example":"string","description":"Property data type.","enum":["date","number","string","url"]},"name":{"type":"string","description":"Property name."},"value":{"type":"string","example":"string","description":"Property value. Value format should match dataType. If dataType is \"number\", value should be passed in JSON number format, e.g. 3.14. If dataType is \"date\", the value should be passed in JSON date format, e.g. 2021-02-17T02:30:00-08:00. If the dataType is \"url\", the value should be valid URL, e.g. \"https://example.com/example?q=v\""}},"title":"Generic Property"},"GenericCrmIntegration":{"type":"object","properties":{"integrationId":{"type":"integer","format":"int64","example":5517027188234205706,"description":"Integration ID generated by Gong"},"name":{"type":"string","example":"ACME Sandbox","description":"Integration name"},"ownerEmail":{"type":"string","example":"joe.doe@acme.com","description":"Email of the integration owner"}},"title":"GenericCrmIntegration"},"GenericCrmRegistrationRequest":{"type":"object","required":["name","ownerEmail"],"properties":{"name":{"type":"string","example":"ACME Sandbox","description":"Integration name."},"ownerEmail":{"type":"string","example":"joe.doe@acme.com","description":"Email address of the person responsible for the integration."}},"title":"GenericCrmRegistrationRequest"},"GenericDealStageRequest":{"type":"object","required":["internalName","isActive","name","sortOrder"],"properties":{"internalName":{"type":"string","example":"discovery","description":"Unique name or unique identifier that identifies the stage in the CRM"},"isActive":{"type":"boolean","example":true,"description":"Indicates if the stage is active in the CRM"},"name":{"type":"string","example":"Discovery","description":"Stage name (for display in Gong UI)"},"sortOrder":{"type":"integer","format":"int32","example":1,"description":"The order of the stage in the sales process (starting from 1)"}},"title":"GenericDealStageRequest"},"GenericSchemaFieldRequest":{"type":"object","required":["label","type","uniqueName"],"properties":{"isDeleted":{"type":"boolean","example":false,"description":"\"true\" deletes the field from the schema and its value is removed from all objects. Use with caution."},"label":{"type":"string","example":"Account Owner","description":"The label is used to display the field"},"lastModified":{"type":"string","example":"2020-12-17T13:45:01Z","description":"The last modification timestamp of the field schema. <br>The timestamp should be in the ISO-8601 format without milliseconds e.g., \"2020-12-17T13:45:01Z\""},"name":{"type":"string","example":"accountowner","description":"<b>Deprecated</b>. Please use uniqueName"},"orderedValueList":{"type":"array","example":["Analyst","Competitor","Customer","Integrator","Investor","Partner","Other"],"description":"Required for fields of type PICKLIST. Provides the list of available values for the field","items":{"type":"string"}},"referenceTo":{"type":"string","example":"USER","description":"Required for field of type REFERENCE. Defines the type of object referred to by this field. Must be one of \"ACCOUNT\", \"CONTACT\", \"DEAL\", \"LEAD\" or \"USER\""},"type":{"type":"string","example":"REFERENCE","description":"The field type (case-sensitive). See the <b>Supported Field Types</b> table.","enum":["BOOLEAN","CURRENCY","DATE","DATETIME","EMAILADDRESS","ID","NUMBER","PERCENT","PHONENUMBER","PICKLIST","REFERENCE","STRING","STRINGARRAY","URL"]},"uniqueName":{"type":"string","example":"accountowner","description":"The unique name of the field in the CRM system"}},"title":"GenericSchemaFieldRequest"},"GetGenericCrmObjectsResponse":{"type":"object","properties":{"crmObjectsMap":{"type":"object","description":"crmObjects","additionalProperties":{"type":"object","additionalProperties":{"type":"object","properties":{}}}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"GetGenericCrmObjectsResponse"},"InsightsAccessWithPermissionLevel":{"type":"object","properties":{"permissionLevel":{"type":"string","description":"Permission access scope.","enum":["all / managers-team / report-to-them / own / none"]},"teamLeadIds":{"type":"array","example":["295738305212375930"],"description":"List of user IDs to populate the managers-team permission level\n\nYou can retrieve the user ids by using the “Users” API.","uniqueItems":true,"items":{"type":"string"}}},"title":"InsightsAccessWithPermissionLevel","description":"Insights access permission."},"IntegrationStatusRequest":{"type":"object","properties":{"emails":{"type":"array","description":"String array of emails of users (max 100)","items":{"type":"string"}}},"title":"IntegrationStatusRequest"},"IntegrationStatusResponse":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"users":{"type":"array","description":"The integration status for the request users","items":{"$ref":"#/definitions/User Integration Status","originalRef":"#/definitions/User Integration Status"}}},"title":"IntegrationStatusResponse"},"Interaction":{"type":"object","properties":{"interactionStats":{"type":"array","description":"A list of interaction statistics. Applicable values: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience'.","items":{"$ref":"#/definitions/InteractionStats","originalRef":"#/definitions/InteractionStats"}},"questions":{"description":"Questions counts of the call.","$ref":"#/definitions/Questions","originalRef":"#/definitions/Questions"},"speakers":{"type":"array","description":"A list of the talk duration per speaker.","items":{"$ref":"#/definitions/Speaker","originalRef":"#/definitions/Speaker"}},"video":{"type":"array","description":"A list of video statistics about what's presented and for how long.","items":{"$ref":"#/definitions/Video","originalRef":"#/definitions/Video"}}},"title":"Interaction","description":"Metrics collected around the interaction during the call."},"InteractionStat":{"type":"object","properties":{"name":{"type":"string","example":"Interactivity","description":"Stat name"},"value":{"type":"number","format":"double","example":9.23,"description":"Stat measurement (Can be either a double or integer)"}},"title":"InteractionStat"},"InteractionStats":{"type":"object","properties":{"personInteractionStats":{"type":"array","items":{"$ref":"#/definitions/InteractionStat","originalRef":"#/definitions/InteractionStat"}},"userEmailAddress":{"type":"string","example":"test@test.com","description":"The email address of the Gong user."},"userId":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user (up to 20 digits)."}},"title":"InteractionStats"},"LibraryCall":{"type":"object","properties":{"addedBy":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user who added the call to folder."},"created":{"type":"string","example":"2020-01-12T14:30:00-08:00","description":"The date and time when the call was added to folder in the ISO-8601 format (e.g., '2020-01-12T14:30:00-08:00')."},"id":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric identifier of a call (up to 20 digits)."},"note":{"type":"string","example":"sample note","description":"A note attached to the call in the folder. The note is optional."},"snippet":{"description":"When the folder contains a snippet of the call, this element defines the snippet timing.","$ref":"#/definitions/Snippet","originalRef":"#/definitions/Snippet"},"title":{"type":"string","example":"Example call","description":"The title of the call."},"url":{"type":"string","example":"https://app.gong.io/call?id=3636865806219496180&highlights=%5B%7B%22to%22%3A+3240%2C+%22from%22%3A+1200%2C+%22type%22%3A+%22LIBRARY%22%7D%5D","description":"URL of the call."}},"title":"LibraryCall","description":"Basic details such as id, title, notes, etc."},"LibraryFolder":{"type":"object","properties":{"createdBy":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user who added the folder."},"id":{"type":"string","example":"3843152912968920037","description":"Gong's unique numeric identifier for a library's folder (up to 20 digits)."},"name":{"type":"string","example":"Sales Onboarding","description":"Display name of the folder."},"parentFolderId":{"type":"string","example":"295738305212375930","description":"Gong's unique numeric identifier for library's parent folder (null for root folder)."},"updated":{"type":"string","example":"2020-03-14T05:30:00-08:00","description":"Folder's last update time in the ISO-8601 format (e.g., '2020-03-14T05:30:00-08:00')."}},"title":"LibraryFolder","description":"Basic details such as sub-folders, title, etc."},"LibraryFolderAccess":{"type":"object","properties":{"libraryFolderIds":{"type":"array","example":["3843152912968920037"],"description":"List of library folder Ids, if set, \"permissionLevel\" must not be \"none\".","uniqueItems":true,"items":{"type":"string"}},"manageFolderCalls":{"type":"boolean","example":true,"description":"A user with this profile can add calls to folders, archive calls, if set, \"permissionLevel\" must not be \"none\"."},"managePublicFolder":{"type":"boolean","example":true,"description":"A user with this profile can manage public folder, if set, \"permissionLevel\" must not be \"none\"."},"manageStreams":{"type":"boolean","example":true,"description":"A user with this profile can manage streams, if set, \"permissionLevel\" must not be \"none\"."},"permissionLevel":{"type":"string","description":"Library folder permission level - mandatory value.","enum":["all","none","specific-folders"]}},"title":"LibraryFolderAccess","description":"Library folder access permission."},"LibraryFolderListOfCallsResponse":{"type":"object","properties":{"calls":{"type":"array","description":"A list, in which each item represents one library call.","items":{"$ref":"#/definitions/LibraryCall","originalRef":"#/definitions/LibraryCall"}},"createdBy":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user who added the folder."},"id":{"type":"string","example":"3843152912968920037","description":"Gong's unique numeric identifier for a library's folder (up to 20 digits)."},"name":{"type":"string","example":"Sales Onboarding","description":"Display name of the folder."},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"updated":{"type":"string","example":"2020-03-14T05:30:00-08:00","description":"Folder's last update time in the ISO-8601 format (e.g., '2020-03-14T05:30:00-08:00')."}},"title":"LibraryFolderListOfCallsResponse"},"LibraryResponse":{"type":"object","properties":{"folders":{"type":"array","description":"A list, in which each item specifies one folder.","items":{"$ref":"#/definitions/LibraryFolder","originalRef":"#/definitions/LibraryFolder"}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"LibraryResponse"},"LineErrorResponse":{"type":"object","properties":{"description":{"type":"string","example":"Mandatory field [objectId] is missing or empty","description":"Error description"},"line":{"type":"integer","format":"int32","example":49,"description":"Line number of failed object"}},"title":"LineErrorResponse"},"ListGenericCrmIntegrationsResponse":{"type":"object","properties":{"integrations":{"type":"array","description":"Active Integration","items":{"$ref":"#/definitions/GenericCrmIntegration","originalRef":"#/definitions/GenericCrmIntegration"}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"ListGenericCrmIntegrationsResponse"},"ListSelectedFieldsResponse":{"type":"object","properties":{"objectTypeToSelectedFields":{"type":"object","description":"selectedFields","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/GenericSchemaFieldRequest","originalRef":"#/definitions/GenericSchemaFieldRequest"}}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"ListSelectedFieldsResponse"},"LogsResponse":{"type":"object","properties":{"logEntries":{"type":"array","description":"A list, in which each item specifies one log.","items":{"$ref":"#/definitions/logEntry","originalRef":"#/definitions/logEntry"}},"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"LogsResponse"},"ManualAssociationResponse":{"type":"object","properties":{"associations":{"type":"array","description":"A list, in which each item specifies one manual call association.","items":{"$ref":"#/definitions/ManualAssociationsBasicData","originalRef":"#/definitions/ManualAssociationsBasicData"}},"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"ManualAssociationResponse"},"ManualAssociationsBasicData":{"type":"object","properties":{"associatedCrmObjects":{"type":"array","description":"List of all association objects.","items":{"$ref":"#/definitions/AssociationObject","originalRef":"#/definitions/AssociationObject"}},"callId":{"type":"string","example":"7782342274025937895","description":"Gong's unique numeric identifier for the call (up to 20 digits)."},"created":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The association date."},"userId":{"type":"string","example":"234599484848423","description":"The user Id who performed the association."}},"title":"ManualAssociationsBasicData","description":"Basic association details such as call Id, etc."},"Media":{"type":"object","properties":{"audioUrl":{"type":"string","description":"If true and exist, add audio url of the call. The url will be available for 8 hours."},"videoUrl":{"type":"string","description":"If true and exist, add video url of the call. The url will be available for 8 hours."}},"title":"Media","description":"The media urls of the call."},"Meeting":{"type":"object","properties":{"id":{"type":"string","example":"8059707022269524529.sb5gr1tgpt5dd799eh035rb3dk@google.com_2022-06-30T13:00:00Z","description":"Gong's unique identifier for the meeting."}},"title":"Meeting"},"MeetingInvitee":{"type":"object","properties":{"displayName":{"type":"string","example":"Test User","description":"The name of the person."},"email":{"type":"string","example":"test@test.com","description":"The unique meeting to identify the meeting."},"firstName":{"type":"string","example":"Jon","description":"The first name of the person, if available."},"lastName":{"type":"string","example":"Snow","description":"The last name of the person, if available."}},"title":"MeetingInvitee"},"MeetingsErrorResponse":{"type":"object","properties":{"errors":{"type":"object","example":["An error has occurred"],"description":"Error messages.","properties":{}},"fixUrl":{"type":"string","format":"uri","example":"https://app.gong.io/company/recording-consent/consent-page","description":"Link to Gong where a Gong administrator can fix the issue"},"helpUrl":{"type":"string","format":"uri","example":"https://help.gong.io/hc/en-us/articles/360056677792","description":"Link to Gong help center."},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"userFacingError":{"type":"string","example":"The Gong consent page is not enabled in your company. Contact your Gong Admin.","description":"User facing error messages."}},"title":"MeetingsErrorResponse"},"Monologue":{"type":"object","properties":{"sentences":{"type":"array","description":"A list of sentences spoken in the monologue.","items":{"$ref":"#/definitions/Sentence","originalRef":"#/definitions/Sentence"}},"speakerId":{"type":"string","example":"6432345678555530067","description":"Unique ID of the speaker. Cross-reference this with the 'speakerId' field of objects in the 'parties' array returned from endpoint '/v2/calls/extensive' to identify the participant. "},"topic":{"type":"string","example":"Objections","description":"The name of the topic."}},"title":"Monologue"},"MultipleUsersRequestWithCreationDates":{"type":"object","properties":{"createdFromDateTime":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"An optional user creation time lower limit, if supplied the API will return only the users created at or after this time. The filed is in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"createdToDateTime":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"An optional user creation time upper limit, if supplied the API will return only the users created before this time. The filed is in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"includeAvatars":{"type":"boolean","example":false,"description":"Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars' IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results."},"userIds":{"type":"object","example":["234599484848423"],"description":"Set of Gong's unique numeric identifiers for the users (up to 20 digits).","properties":{}}},"title":"MultipleUsersRequestWithCreationDates","description":"Filter parameters."},"MultipleUsersWithDates":{"type":"object","required":["fromDate","toDate"],"properties":{"fromDate":{"type":"string","format":"date","example":"2019-01-20","description":"The date (in the company's time zone) from which to list a user's activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD."},"toDate":{"type":"string","format":"date","example":"2019-01-21","description":"The date (in the company's time zone) until which to list a user's activity. This value is exclusive. This value should not exceed the current day.The date should be specified in the following format: YYYY-MM-DD."},"userIds":{"type":"object","example":["234599484848423"],"description":"Set of Gong's unique numeric identifiers for the users (up to 20 digits).","properties":{}}},"title":"MultipleUsersWithDates","description":"Filter parameters."},"NewCallAddingRequest":{"type":"object","required":["actualStart","clientUniqueId","direction","parties","primaryUser"],"properties":{"actualStart":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The actual date and time when the call started in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);"},"callProviderCode":{"type":"string","example":"clearslide","description":"The code identifies the provider conferencing or telephony system. For example: zoom, clearslide, gotomeeting, ringcentral, outreach, insidesales, etc. These values are predefined by Gong, please contact help@gong.io to find the proper value for your system."},"clientUniqueId":{"type":"string","example":"123abc","description":"A call's unique identifier in the PBX or the recording system. Gong uses this identifier to prevent repeated attempts to upload the same recording."},"context":{"type":"array","description":"A list of references to external systems such as CRM, Telephony System, Case Management, etc.","items":{"$ref":"#/definitions/CallUploadContext","originalRef":"#/definitions/CallUploadContext"}},"customData":{"type":"string","example":"Optional data","description":"Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting."},"direction":{"type":"string","description":"Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.","enum":["Conference","Inbound","Outbound","Unknown"]},"disposition":{"type":"string","example":"No Answer","description":"The disposition of the call. The disposition is free text of up to 255 characters."},"downloadMediaUrl":{"type":"string","example":"ftp://upload-server.com/sample-call.mp3","description":"The URL from which Gong can download the media file.\nThe URL must be unique, the audio or video file must be a maximum of 1.5GB.\nIf you provide this URL, you should not perform the 'Add call media' step."},"duration":{"type":"number","format":"float","example":125.8,"description":"The actual call duration in seconds."},"languageCode":{"type":"string","description":"The language code the call should be transcribed to.\nThis field is optional as Gong automatically detects the language spoken in the call and transcribes it accordingly. Set this field only if you are sure of the language the call is in.\nValid values are: af-ZA, am-ET, ar-AE, ar-BH, ar-DZ, ar-EG, ar-IL, ar-IQ, ar-JO, ar-KW, ar-LB, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-TN, ar-YE, az-AZ, bg-BG, bn-BD, bn-IN, bs-BA, ca-ES, cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AB, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-PH, en-SG, en-US, en-WL, en-ZA, es-AR, es-BO, es-CL, es-CO, es-CR, es-DO, es-EC, es-ES, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PR, es-PY, es-SV, es-US, es-UY, et-EE, eu-ES, fa-IR, fi-FI, fil-PH, fr-BE, fr-CA, fr-CH, fr-FR, gl-ES, gu-IN, he-IL, hi-IN, hr-HR, hu-HU, hy-AM, id-ID, is-IS, it-CH, it-IT, ja-JP, jv-ID, ka-GE, kk-KZ, km-KH, kn-IN, ko-KR, lo-LA, lt-LT, lv-LV, mk-MK, ml-IN, mn-MN, mr-IN, ms-MY, my-MM, ne-NP, nl-BE, nl-NL, no-NO, pa-Guru-IN, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, si-LK, sk-SK, sl-SI, sq-AL, sr-RS, su-ID, sv-SE, sw-KE, sw-TZ, ta-IN, ta-LK, ta-MY, ta-SG, te-IN, th-TH, tr-TR, uk-UA, ur-IN, ur-PK, uz-UZ, vi-VN, yue-Hant-HK, zh-CN, zh-TW, zu-ZA"},"meetingUrl":{"type":"string","example":"https://www.conference.com/john.smith","description":"The URL of the conference call by which users join the meeting"},"parties":{"type":"array","description":"A list of the call's participants. A party must be provided for the primaryUser.","items":{"$ref":"#/definitions/CallParticipant","originalRef":"#/definitions/CallParticipant"}},"primaryUser":{"type":"string","example":"234599484848423","description":"The Gong internal user ID of the team member who hosted the call."},"purpose":{"type":"string","example":"Demo Call","description":"The purpose of the call. This optional field is a free text of up to 255 characters."},"scheduledEnd":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"The date and time the call was scheduled to end in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);"},"scheduledStart":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date and time the call was scheduled to begin in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);"},"speakersTimeline":{"description":"The audio recording speech segments (who spoke when). Note that speakersTimeline and mediaChannelId are mutually exclusive, when providing speakersTimeline - mediaChannelId will not be used.","$ref":"#/definitions/SpeakersTimeline","originalRef":"#/definitions/SpeakersTimeline"},"title":{"type":"string","example":"Example call","description":"The title of the call. This title is available in the Gong system for indexing and search."},"workspaceId":{"type":"string","example":"623457276584334","description":"Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied."}},"title":"NewCallAddingRequest","description":"New call metadata"},"NewCallAddingResponse":{"type":"object","properties":{"callId":{"type":"string","example":"7782342274025937895","description":"New call ID"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"NewCallAddingResponse"},"NewCallRecordingResponse":{"type":"object","properties":{"callId":{"type":"string","example":"7782342274025937895","description":"New call ID"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"url":{"type":"string","example":"https://app.gong.io/call?id=7782342274025937895","description":"The URL to the page in the Gong web application where the call is available."}},"title":"NewCallRecordingResponse"},"NewMeetingRequest":{"type":"object","required":["invitees"],"properties":{"endTime":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"The meeting end time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"externalId":{"type":"string","example":"7JEHFRGXDDZFEW2FC4U","description":"The ID as it is formed on the external system."},"invitees":{"type":"array","example":[{"displayName":"Cookie Monster","email":"cookie.monster@cookies.com"}],"description":"A list of email addresses of invitees to the event (not including the organizer).","items":{"$ref":"#/definitions/MeetingInvitee","originalRef":"#/definitions/MeetingInvitee"}},"organizerEmail":{"type":"string","example":"test@test.com","description":"The email address of the user creating the meeting, the Gong consent page link will be used according to the settings of this user."},"startTime":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The meeting start time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"title":{"type":"string","example":"Example call","description":"Title of the event."}},"title":"NewMeetingRequest","description":"New meeting metadata"},"NewMeetingResponse":{"type":"object","properties":{"additionalInvitees":{"type":"array","example":[{"displayName":"Gong Assistant","email":"assistant@gong.io"}],"description":"Attendees the requesting party should add to the invitation, this should support adding email addresses such as coordinator@gong.io for Gong to schedule the recording of the meeting.","items":{"$ref":"#/definitions/MeetingInvitee","originalRef":"#/definitions/MeetingInvitee"}},"meetingId":{"type":"string","example":"7782342274025937895","description":"Gong's unique identifier for the meeting (up to 20 digits)."},"meetingUrl":{"type":"string","example":"https://join.gong.io/my-company/jon.snow?tkn=MoNpS9tMNt8BK7EZxQpSJl","description":"The Gong URL of the meeting, should be used to enter the meeting."},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"NewMeetingResponse"},"Party":{"type":"object","properties":{"affiliation":{"type":"string","description":"Whether the participant is from the company or not.","enum":["External","Internal","Unknown"]},"context":{"type":"array","description":"A list of links to external systems such as CRM, Dialer, Case Management, etc.","items":{"$ref":"#/definitions/PartyContext","originalRef":"#/definitions/PartyContext"}},"emailAddress":{"type":"string","example":"test@test.com","description":"Email address."},"id":{"type":"string","example":"56825452554556","description":"Unique ID of the participant in the call."},"methods":{"type":"array","description":"Whether the participant was invited to the meeting or only attended the call.","items":{"type":"string","enum":["Attendee","Invitee"]}},"name":{"type":"string","example":"Test User","description":"The name of the participant."},"phoneNumber":{"type":"string","example":"+1 123-567-8989","description":"The phone number of the participant."},"speakerId":{"type":"string","example":"6432345678555530067","description":"Unique ID of a participant that spoke in the call. References to this id will appear in the '/v2/calls/transcript' endpoint response."},"title":{"type":"string","example":"Enterprise Account Executive","description":"The job title of the participant"},"userId":{"type":"string","example":"234599484848423","description":"The user ID of the participant within the Gong system, if the participant exists in the system."}},"title":"Party"},"PartyContext":{"type":"object","properties":{"objects":{"type":"array","description":" List of objects within the external system","items":{"$ref":"#/definitions/ExternalPartyObject","originalRef":"#/definitions/ExternalPartyObject"}},"system":{"type":"string","example":"Salesforce","description":"External system name. e.g. Salesforce","enum":["Generic","HubSpot","MicrosoftDynamic","Salesforce"]}},"title":"PartyContext","description":"Links to external systems such as CRM, Dialer, Case Management etc"},"PartyContextField":{"type":"object","properties":{"name":{"type":"string","example":"name","description":"Field name. All custom fields are supported."},"value":{"type":"object","example":"Gong Inc.","description":"Object value","properties":{}}},"title":"PartyContextField","description":"External object data"},"PartyUploadContext":{"type":"object","required":["system"],"properties":{"objects":{"type":"array","description":"List of objects within the external system","items":{"$ref":"#/definitions/ExternalCrmPartyObject","originalRef":"#/definitions/ExternalCrmPartyObject"}},"system":{"type":"string","example":"Salesforce","description":"External system name. Currently only Salesforce and Generic are supported.","enum":["Salesforce"]}},"title":"PartyUploadContext","description":"Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported."},"PermissionProfileDTO":{"type":"object","properties":{"account":{"type":"boolean","example":true,"description":"User can view account pages."},"activity":{"type":"boolean","example":true,"description":"User can view activity pages."},"callsAccess":{"$ref":"#/definitions/CallAccessWithPermissionLevel","originalRef":"#/definitions/CallAccessWithPermissionLevel"},"callsAndSearch":{"type":"boolean","example":true,"description":"User can view and search calls."},"coaching":{"type":"boolean","example":true,"description":"User can view coaching pages."},"coachingAccess":{"$ref":"#/definitions/CoachingAccessWithPermissionLevel","originalRef":"#/definitions/CoachingAccessWithPermissionLevel"},"createEditAndDeleteDealsBoards":{"type":"boolean","example":true,"description":"User can create/edit/delete deals boards."},"crmDataImport":{"type":"boolean","example":true,"description":"User can perform import of crm data."},"crmDataInlineEditing":{"type":"boolean","example":true,"description":"User can perform inline editing of crm data."},"deals":{"type":"boolean","example":true,"description":"User can view deals pages."},"dealsAccess":{"$ref":"#/definitions/DealsAccessWithPermissionLevel","originalRef":"#/definitions/DealsAccessWithPermissionLevel"},"dealsInlineEditing":{"type":"boolean","example":true,"description":"User can perform inline editing of deals."},"deleteCalls":{"type":"boolean","example":true,"description":"User can delete calls."},"deleteEmails":{"type":"boolean","example":true,"description":"User can delete emails."},"description":{"type":"string","example":"Description","description":"Permission profile description."},"downloadCallMedia":{"type":"boolean","example":true,"description":"User can download call media."},"emailsAccess":{"$ref":"#/definitions/EmailsAccessWithPermissionLevel","originalRef":"#/definitions/EmailsAccessWithPermissionLevel"},"exportCallsAndCoachingDataToCSV":{"type":"boolean","example":true,"description":"User can export calls and coaching metrics data to CSV."},"forecast":{"type":"boolean","example":true,"description":"User can view forecast pages."},"forecastAccess":{"$ref":"#/definitions/ForecastAccessWithPermissionLevel","originalRef":"#/definitions/ForecastAccessWithPermissionLevel"},"id":{"type":"string","example":"3843152912968920037","description":"Unique numeric identifier of the permission profile (up to 20 digits)."},"initiatives":{"type":"boolean","example":true,"description":"User can view initiatives page."},"insights":{"type":"boolean","example":true,"description":"User can view insights pages."},"insightsAccess":{"$ref":"#/definitions/InsightsAccessWithPermissionLevel","originalRef":"#/definitions/InsightsAccessWithPermissionLevel"},"library":{"type":"boolean","example":true,"description":"User can view library pages."},"libraryFolderAccess":{"description":"Library folders access permission.","$ref":"#/definitions/LibraryFolderAccess","originalRef":"#/definitions/LibraryFolderAccess"},"manageGeneralBusinessSettings":{"type":"boolean","example":true,"description":"User can manage general business settings."},"manageScorecards":{"type":"boolean","example":true,"description":"User can manage scorecards."},"manuallyScheduleAndUploadCalls":{"type":"boolean","example":true,"description":"User can manually schedule and upload calls."},"market":{"type":"boolean","example":true,"description":"User can view market page."},"name":{"type":"string","example":"Profile","description":"Permission profile name."},"privateCalls":{"type":"boolean","example":true,"description":"User can set their own calls as private."},"scoreCalls":{"type":"boolean","example":true,"description":"User can score calls."},"shareCallsWithCustomers":{"type":"boolean","example":true,"description":"User can share calls with customers."},"teamStats":{"type":"boolean","example":true,"description":"User can view team stats page."}},"title":"PermissionProfileDTO","description":"Permission profile"},"PermissionProfileResponse":{"type":"object","properties":{"profile":{"description":"A permission profile.","$ref":"#/definitions/PermissionProfileDTO","originalRef":"#/definitions/PermissionProfileDTO"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"PermissionProfileResponse"},"PermissionProfileUsersResponse":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"users":{"type":"array","description":"A list, in which each item specifies a user attached to the permission profile.","items":{"$ref":"#/definitions/UserSimpleMetadata","originalRef":"#/definitions/UserSimpleMetadata"}}},"title":"PermissionProfileUsersResponse"},"PermissionProfilesResponse":{"type":"object","properties":{"profiles":{"type":"array","description":"A list, in which each item specifies a permission profile.","items":{"$ref":"#/definitions/PermissionProfileDTO","originalRef":"#/definitions/PermissionProfileDTO"}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"PermissionProfilesResponse"},"PhoneNumberReferences":{"type":"object","properties":{"calls":{"type":"array","description":"Related calls.","items":{"$ref":"#/definitions/CallReference","originalRef":"#/definitions/CallReference"}},"customerData":{"type":"array","description":"A list of links to data from external systems (such as CRM, Telephony System, Case Management, etc.) that reference the email address and that Gong stores.","items":{"$ref":"#/definitions/CustomerData","originalRef":"#/definitions/CustomerData"}},"emailAddresses":{"type":"array","description":"Related email addresses.","uniqueItems":true,"items":{"type":"string"}},"emails":{"type":"array","description":"Related email messages.","items":{"$ref":"#/definitions/EmailMessage","originalRef":"#/definitions/EmailMessage"}},"matchingPhoneNumbers":{"type":"array","description":"Matching phone numbers found.","uniqueItems":true,"items":{"type":"string"}},"meetings":{"type":"array","description":"Related meetings.","items":{"$ref":"#/definitions/Meeting","originalRef":"#/definitions/Meeting"}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"suppliedPhoneNumber":{"type":"string","description":"The supplied phone number."}},"title":"PhoneNumberReferences"},"PointOfInterest":{"type":"object","properties":{"snippet":{"type":"string","example":"And I'll send you an invite with a link that you can use at that time as well.","description":"The snippet including the action."},"snippetEndTime":{"type":"number","format":"double","example":26.0,"description":"The number of seconds from the beginning of the call that the snippet end refers to."},"snippetStartTime":{"type":"number","format":"double","example":26.0,"description":"The number of seconds from the beginning of the call that the snippet start refers to."},"speakerID":{"type":"string","example":"56825452554556","description":"Unique ID of the participant in the call."}},"title":"PointOfInterest"},"PointsOfInterest":{"type":"object","properties":{"actionItems":{"type":"array","description":"A list of action items.","items":{"$ref":"#/definitions/PointOfInterest","originalRef":"#/definitions/PointOfInterest"}}},"title":"PointsOfInterest","description":"Points of interest of the call."},"Question":{"type":"object","properties":{"created":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date and time when the question was created in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"isOverall":{"type":"boolean","example":false,"description":"If the question is the main overall question."},"questionId":{"type":"string","example":"35657219295037524478","description":"The identifier for the question."},"questionRevisionId":{"type":"string","example":"43955224753211112","description":"The identifier for the revision version of the question."},"questionText":{"type":"string","example":"How do you evaluate the SDR's overall performance in the call?","description":"The question's text."},"updated":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"The date and time when the question was updated in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"updaterUserId":{"type":"string","example":"234599484848423","description":"The user Id of the team member that updated the question."}},"title":"Question"},"Questions":{"type":"object","properties":{"companyCount":{"type":"integer","format":"int32","description":"The number of questions asked by company speakers."},"nonCompanyCount":{"type":"integer","format":"int32","description":"The number of questions asked by non-company speakers."}},"title":"Questions","description":"Question counts of the call."},"Records":{"type":"object","properties":{"currentPageNumber":{"type":"integer","format":"int32","example":0,"description":"Current page number."},"currentPageSize":{"type":"integer","format":"int32","example":100,"description":"Number of records in the current page."},"cursor":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM","description":"Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records."},"totalRecords":{"type":"integer","format":"int32","example":263,"description":"Total number of records."}},"title":"Records","description":"Information about the number of records that match the requested filter."},"RegisterGenericCrmResponse":{"type":"object","properties":{"integrationId":{"type":"integer","format":"int64","example":5517027188234205706,"description":"<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}</style>Use the Gong integration ID in future requests to the API. This ensures you are accessing the correct integration. <br><div class='public-api-tip'>You will need a library that can parse the <code class='public-api-parameter'>integrationId</code> in the response as Long or BigInt. Parsing the <code class='public-api-parameter'>integrationId</code> as an Integer will truncate the <code class='public-api-parameter'>integrationId</code> to trailing zeros and will return an incorrect id.</div>"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"RegisterGenericCrmResponse"},"RequestStatusResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/LineErrorResponse","originalRef":"#/definitions/LineErrorResponse"}},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"status":{"type":"string","example":"FAILED","description":"Request status","enum":["DONE","FAILED","IN_PROGRESS","PENDING"]},"totalErrorCount":{"type":"integer","format":"int32","example":3,"description":"Number of objects that failed parsing"},"totalSuccessCount":{"type":"integer","format":"int32","example":97,"description":"Number of valid objects"}},"title":"RequestStatusResponse"},"RequestWithTimePeriod«MultipleUsersWithDates»":{"type":"object","required":["aggregationPeriod"],"properties":{"aggregationPeriod":{"type":"string","example":"DAY","description":"Calendar time period for aggregating data. Note: First day of the week is Monday.","enum":["DAY","MONTH","QUARTER","WEEK","YEAR"]},"cursor":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records."},"filter":{"description":"Filters","$ref":"#/definitions/MultipleUsersWithDates","originalRef":"#/definitions/MultipleUsersWithDates"}},"title":"RequestWithTimePeriod«MultipleUsersWithDates»"},"Request«AnsweredScorecardsFilter»":{"type":"object","properties":{"cursor":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records."},"filter":{"description":"Filters","$ref":"#/definitions/AnsweredScorecardsFilter","originalRef":"#/definitions/AnsweredScorecardsFilter"}},"title":"Request«AnsweredScorecardsFilter»"},"Request«CallsAccessGetDto»":{"type":"object","properties":{"filter":{"description":"Filters","$ref":"#/definitions/CallsAccessGetDto","originalRef":"#/definitions/CallsAccessGetDto"}},"title":"Request«CallsAccessGetDto»"},"Request«CallsFilter»":{"type":"object","properties":{"cursor":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records."},"filter":{"description":"Filters","$ref":"#/definitions/CallsFilter","originalRef":"#/definitions/CallsFilter"}},"title":"Request«CallsFilter»"},"Request«CallsRequestFilterWithOwners,ContentSelector»":{"type":"object","properties":{"contentSelector":{"$ref":"#/definitions/ContentSelector","originalRef":"#/definitions/ContentSelector"},"cursor":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records."},"filter":{"description":"Filters","$ref":"#/definitions/CallsRequestFilterWithOwners","originalRef":"#/definitions/CallsRequestFilterWithOwners"}},"title":"Request«CallsRequestFilterWithOwners,ContentSelector»"},"Request«MultipleUsersRequestWithCreationDates»":{"type":"object","properties":{"cursor":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records."},"filter":{"description":"Filters","$ref":"#/definitions/MultipleUsersRequestWithCreationDates","originalRef":"#/definitions/MultipleUsersRequestWithCreationDates"}},"title":"Request«MultipleUsersRequestWithCreationDates»"},"Request«MultipleUsersWithDates»":{"type":"object","properties":{"cursor":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM","description":"When paging is needed, provide the value supplied by the previous API call to bring the following page of records."},"filter":{"description":"Filters","$ref":"#/definitions/MultipleUsersWithDates","originalRef":"#/definitions/MultipleUsersWithDates"}},"title":"Request«MultipleUsersWithDates»"},"SchemaUpdateResponse":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"SchemaUpdateResponse"},"Scorecard":{"type":"object","properties":{"created":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The date and time when the scorecard was created in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"enabled":{"type":"boolean","example":true,"description":"If the scorecard is enabled or not."},"questions":{"type":"array","description":"The questions in the scorecard.","items":{"$ref":"#/definitions/Question","originalRef":"#/definitions/Question"}},"scorecardId":{"type":"string","example":"6843152929075440037","description":"The identifier of the scorecard."},"scorecardName":{"type":"string","example":"SDR Call Scorecard","description":"Scorecard name."},"updated":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"The date and time when the scorecard was updated in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"updaterUserId":{"type":"string","example":"234599484848423","description":"The user Id of the team member that updated the scorecard."},"workspaceId":{"type":"string","example":"623457276584334","description":"Scorecard workspaceId."}},"title":"Scorecard"},"Scorecards":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"scorecards":{"type":"array","description":"A list, in which each item contains one scorecard.","items":{"$ref":"#/definitions/Scorecard","originalRef":"#/definitions/Scorecard"}}},"title":"Scorecards"},"Sentence":{"type":"object","properties":{"end":{"type":"integer","format":"int64","example":462343,"description":"The end time of the sentence, in milliseconds from the start of the call."},"start":{"type":"integer","format":"int64","example":460230,"description":"The starting time of the sentence, in milliseconds from the start of the call."},"text":{"type":"string","example":"No wait, I think we should check that out first.","description":"The sentence."}},"title":"Sentence"},"Settings":{"type":"object","properties":{"emailsImported":{"type":"boolean","example":true,"description":"True if the team member is set to import emails by Gong, false if not."},"nonRecordedMeetingsImported":{"type":"boolean","example":true,"description":"True if the team member is set to import non recorded meetings by Gong, false if not."},"preventEmailImport":{"type":"boolean","description":"True if the team member is set to prevent import of emails by Gong, false if not."},"preventWebConferenceRecording":{"type":"boolean","description":"If true, invitation of this user to a web conference will prevent its recording (even if other users invited are set to record)."},"telephonyCallsImported":{"type":"boolean","description":"True if the team member is set to import telephony calls from by Gong, false if not."},"webConferencesRecorded":{"type":"boolean","example":true,"description":"True if the team member is set to be recorded by Gong, false if not."}},"title":"Settings","description":"The user's settings in the Gong system."},"SettingsHistory":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"userSettingsHistory":{"type":"array","description":"User's settings history.","items":{"$ref":"#/definitions/UserSettingsHistory","originalRef":"#/definitions/UserSettingsHistory"}}},"title":"SettingsHistory"},"Sharer":{"type":"object","properties":{"email":{"type":"string","example":"test@test.com","description":"The email address of the person, if available."},"id":{"type":"string","example":"234599484848423","description":"The user id in Gong, if available."},"name":{"type":"string","example":"Test User","description":"The name of the person, if available."}},"title":"Sharer"},"Snippet":{"type":"object","properties":{"fromSec":{"type":"integer","format":"int32","example":21,"description":"Call snippet start in seconds relative to the call start time. For example 305 is a snippet that starts after 5 minutes and 5 seconds after the beginning of the call."},"toSec":{"type":"integer","format":"int32","example":132,"description":"Call snippet end in seconds relative to the call start time. For example 900 means that this snippet ends after exactly 15 minutes after the beginning of the call."}},"title":"Snippet","description":"Snippet of call"},"Speaker":{"type":"object","properties":{"id":{"type":"string","example":"56825452554556","description":"Unique ID of the participant in the call."},"talkTime":{"type":"number","format":"double","example":145.0,"description":"Talk duration in seconds"},"userId":{"type":"string","example":"234599484848423","description":"User Id within the Gong system"}},"title":"Speaker","description":"Talking duration"},"SpeakersTimeline":{"type":"object","properties":{"precise":{"type":"boolean","example":true,"description":"Indicates whether the provided speech segments match the media precisely or need further refinement based on the media. \"Precisely\" here means that segments do not deviate from the actual speech in the media by more than 100ms."},"speechSegments":{"type":"array","description":"The audio recording speech segments (who spoke when). ","items":{"$ref":"#/definitions/SpeechSegment","originalRef":"#/definitions/SpeechSegment"}}},"title":"SpeakersTimeline"},"SpecificCall":{"type":"object","properties":{"call":{"description":"call's metadata.","$ref":"#/definitions/CallBasicData","originalRef":"#/definitions/CallBasicData"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"SpecificCall"},"SpeechSegment":{"type":"object","required":["fromTime","partyIds","toTime"],"properties":{"fromTime":{"type":"integer","format":"int32","example":5100,"description":"The start time of the segment in milliseconds from the beginning of the call."},"partyIds":{"type":"array","example":["1"],"description":"The speaking parties in the segment, each must have a correlating partyId within 'parties'. It is allowed to provide overlapping segments, i.e. you can either specify multiple speakers in a segment or send several overlapping segments each marked with one speaker.","items":{"type":"string"}},"toTime":{"type":"integer","format":"int32","example":24000,"description":"The end time of the segment in milliseconds from the beginning of the call."}},"title":"SpeechSegment"},"Structure":{"type":"object","properties":{"duration":{"type":"integer","format":"int64","example":67,"description":"The duration of this part of the call"},"name":{"type":"string","example":"Meeting Setup","description":"The agenda name"}},"title":"Structure","description":"Agenda of the current part of the call"},"UpdateMeetingRequest":{"type":"object","required":["invitees"],"properties":{"endTime":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"The meeting end time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"externalId":{"type":"string","example":"7JEHFRGXDDZFEW2FC4U","description":"The ID as it is formed on the external system."},"invitees":{"type":"array","example":[{"displayName":"Cookie Monster","email":"cookie.monster@cookies.com"}],"description":"A list of email addresses of invitees to the event (not including the organizer).","items":{"$ref":"#/definitions/MeetingInvitee","originalRef":"#/definitions/MeetingInvitee"}},"organizerEmail":{"type":"string","example":"test@test.com","description":"The email address of the user who created the meeting."},"startTime":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The meeting start time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"title":{"type":"string","example":"Example call","description":"Title of the event."}},"title":"UpdateMeetingRequest","description":"Meeting update metadata"},"UpdateMeetingResponse":{"type":"object","properties":{"meetingId":{"type":"string","example":"7782342274025937895","description":"The unique meeting identifier of the meeting."},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."}},"title":"UpdateMeetingResponse"},"User":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"user":{"description":"User's metadata.","$ref":"#/definitions/UserMetadata","originalRef":"#/definitions/UserMetadata"}},"title":"User"},"User Integration Status":{"type":"object","properties":{"email":{"type":"string","example":"test@test.com","description":"The email address meeting organizer"},"exists":{"type":"boolean","example":true,"description":"Whether the user exists in Gong"},"fixUrl":{"type":"string","example":"https://app.gong.io/company/recording-consent/consent-page","description":"A URL to place in the application to fix the problem"},"helpUrl":{"type":"string","example":"https://help.gong.io/hc/en-us/articles/360056677792","description":"A URL to the Gong help center where more information can be found about the error"},"userFacingError":{"type":"string","example":"The Gong consent page is not enabled in your company. Contact your Gong Admin.","description":"The message explaining in case the integration is currently not connected"},"valid":{"type":"boolean","example":false,"description":"Whether the integration is connected for the user"}},"title":"User Integration Status"},"UserAccessDetails":{"type":"object","properties":{"userId":{"type":"string","example":"234599484848423","description":"Gong's unique numeric user ID."}},"title":"UserAccessDetails","description":"User access details"},"UserActivity":{"type":"object","properties":{"userAggregateActivityStats":{"$ref":"#/definitions/AggregateActivity","originalRef":"#/definitions/AggregateActivity"},"userEmailAddress":{"type":"string","example":"test@test.com","description":"The email address of the Gong user."},"userId":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user (up to 20 digits)."}},"title":"UserActivity"},"UserAggregateByPeriodActivities":{"type":"object","properties":{"userAggregateActivity":{"type":"array","description":"A list, in which each item contains aggregate user activity for consecutive time periods in the date range.","items":{"$ref":"#/definitions/AggregateActivityWithDates","originalRef":"#/definitions/AggregateActivityWithDates"}},"userEmailAddress":{"type":"string","example":"test@test.com","description":"The email address of the Gong user."},"userId":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user (up to 20 digits)."}},"title":"UserAggregateByPeriodActivities"},"UserDayByDayActivity":{"type":"object","properties":{"userDailyActivityStats":{"type":"array","description":"Array of daily activity records, one for every day in the date range.","items":{"$ref":"#/definitions/DailyActivityWithDates","originalRef":"#/definitions/DailyActivityWithDates"}},"userEmailAddress":{"type":"string","description":"The email address of the Gong user."},"userId":{"type":"string","description":"Gong's unique numeric identifier for the user (up to 20 digits)."}},"title":"UserDayByDayActivity"},"UserMetadata":{"type":"object","properties":{"active":{"type":"boolean","example":true,"description":"True if the user is active, false if not."},"created":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"Creation time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);of the Gong user."},"emailAddress":{"type":"string","example":"test@test.com","description":"The email address of the Gong user."},"emailAliases":{"type":"object","example":["testAlias@test.com"],"description":"List of email address aliases of the Gong user.","properties":{}},"extension":{"type":"string","example":"123","description":"The extension number of the Gong user."},"firstName":{"type":"string","example":"Jon","description":"The first name of the Gong user."},"id":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user (up to 20 digits)."},"lastName":{"type":"string","example":"Snow","description":"The last name of the Gong user."},"managerId":{"type":"string","example":"563515258458745","description":"The manager ID of the Gong user."},"meetingConsentPageUrl":{"type":"string","example":"https://join.gong.io/my-company/jon.snow?tkn=MoNpS9tMNt8BK7EZxQpSJl","description":"The Gong recording consent meeting link"},"personalMeetingUrls":{"type":"object","example":["https://zoom.us/j/123"],"description":"The list of personal meeting URLs of the Gong user.","properties":{}},"phoneNumber":{"type":"string","example":"+1 123-567-8989","description":"The phone number of the Gong user."},"settings":{"$ref":"#/definitions/Settings","originalRef":"#/definitions/Settings"},"spokenLanguages":{"type":"array","items":{"$ref":"#/definitions/spokenLanguage","originalRef":"#/definitions/spokenLanguage"}},"title":{"type":"string","example":"Enterprise Account Executive","description":"The job title of the Gong user."}},"title":"UserMetadata"},"UserSettingsHistory":{"type":"object","properties":{"setting":{"type":"string","description":"The user capability that was changed","enum":["active","emailsImported","nonRecordedMeetingsImported","preventEmailImport","preventWebConferenceRecording","webConferencesRecorded"]},"time":{"type":"string","example":"2018-02-19T02:30:00-08:00","description":"The date and time the action was set, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."},"value":{"type":"boolean","example":true,"description":"The new value that was set"}},"title":"UserSettingsHistory"},"UserSimpleMetadata":{"type":"object","properties":{"emailAddress":{"type":"string","example":"test@test.com","description":"The email address of the Gong user."},"fullName":{"type":"string","example":"Jon","description":"The full name of the Gong user."},"id":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user (up to 20 digits)."}},"title":"UserSimpleMetadata"},"UsersAggregateByPeriodActivity":{"type":"object","properties":{"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"usersAggregateActivity":{"type":"array","description":"A list, in which each item contains details of one user's activities.","items":{"$ref":"#/definitions/UserAggregateByPeriodActivities","originalRef":"#/definitions/UserAggregateByPeriodActivities"}}},"title":"UsersAggregateByPeriodActivity"},"UsersDayByDayActivity":{"type":"object","properties":{"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"usersDetailedActivities":{"type":"array","description":"A list, in which each item contains one user's activity.","items":{"$ref":"#/definitions/UserDayByDayActivity","originalRef":"#/definitions/UserDayByDayActivity"}}},"title":"UsersDayByDayActivity"},"UsersMetadata":{"type":"object","properties":{"records":{"$ref":"#/definitions/Records","originalRef":"#/definitions/Records"},"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"users":{"type":"array","description":"A list, in which each item specifies one user's metadata.","items":{"$ref":"#/definitions/UserMetadata","originalRef":"#/definitions/UserMetadata"}}},"title":"UsersMetadata"},"Video":{"type":"object","properties":{"duration":{"type":"number","format":"float","example":218.0,"description":"Total video segments duration in seconds."},"name":{"type":"string","example":"Browser","description":"Video segment type. Can have the values: 'Browser', 'Presentation', 'WebcamPrimaryUser', 'WebcamNonCompany', and 'Webcam'.\n\n<b>'Browser'</b>: When the video segment shows a web browser.\n\n<b>'Presentation'</b>: When the video segment shows a presentation (such as PowerPoint).\n\n<b>'WebcamPrimaryUser'</b>: When the video segment shows the webcam of the primary user.\n\n<b>'WebcamNonCompany'</b>: When the video segment shows webcam speakers that gong has identified as being non-company.\n\n<b>'Webcam'</b>: When the video segment shows any webcam."}},"title":"Video","description":"Video statistics"},"WorkspaceMetadata":{"type":"object","properties":{"description":{"type":"string","example":"This is one of our workspaces","description":"The description of the workspace."},"id":{"type":"string","example":"623457276584334","description":"Gong's unique numeric identifier for the workspace (up to 20 digits)."},"name":{"type":"string","example":"Some Workspace","description":"The name of the workspace."}},"title":"WorkspaceMetadata"},"WorkspacesMetadata":{"type":"object","properties":{"requestId":{"type":"string","example":"4al018gzaztcr8nbukw","description":"A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."},"workspaces":{"type":"array","description":"A list, in which each item provides a workspace metadata.","items":{"$ref":"#/definitions/WorkspaceMetadata","originalRef":"#/definitions/WorkspaceMetadata"}}},"title":"WorkspacesMetadata"},"logEntry":{"type":"object","properties":{"eventTime":{"type":"string","example":"2018-02-17T02:30:00-08:00","description":"The time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); when log was created."},"impersonatorCompanyId":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the impersonating user's company id (up to 20 digits), if available."},"impersonatorEmailAddress":{"type":"string","example":"test@test.com","description":"The email address of the impersonating user, if available."},"impersonatorFullName":{"type":"string","example":"Jon Snow","description":"The full name of the impersonating user, if available."},"impersonatorUserId":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the impersonating user (up to 20 digits), if available."},"logRecord":{"type":"object","description":"The list of log fields and associated values. This element will be populated dynamically by the log record, depending on the type of log.","properties":{}},"userEmailAddress":{"type":"string","example":"test@test.com","description":"The email address of the user, if available."},"userFullName":{"type":"string","example":"Jon Snow","description":"The full name of the user, if available."},"userId":{"type":"string","example":"234599484848423","description":"Gong's unique numeric identifier for the user (up to 20 digits), if available."}},"title":"logEntry"},"occurrences":{"type":"object","properties":{"speakerId":{"type":"string","example":"234599484848423","description":"Unique ID of the speaker in the call who said it. It references the speakerID in the “parties” field and in the transcript."},"startTime":{"type":"number","format":"double","example":32.56,"description":"The number of seconds from the beginning of the call when the tracker phrase was captured."}},"title":"occurrences"},"spokenLanguage":{"type":"object","properties":{"language":{"type":"string","example":"es-ES","description":"Language spoken by the user encoded according to the BCP-47 standard."},"primary":{"type":"boolean","example":true,"description":"Indicates the primary language (one per user). The language will be assumed when the system cannot identify the language of a call, e.g., due to poor quality or the call being too short."}},"title":"spokenLanguage","description":"Languages spoken during calls by the Gong user"},"topic":{"type":"object","properties":{"duration":{"type":"integer","format":"int32","example":86,"description":"The total time, in seconds, spent on this topic within the call."},"name":{"type":"string","example":"Objections","description":"The name of the topic (e.g., Pricing)."}},"title":"topic"},"tracker":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":7,"description":"The number of times words in this Tracker occurred in the call."},"id":{"type":"string","example":"56825452554556","description":"The unique ID of the Tracker."},"name":{"type":"string","example":"Competitors","description":"The name of the Tracker (e.g., Stores)."},"occurrences":{"type":"array","description":"A list of details for each occurrence of Tracker phrases.","items":{"$ref":"#/definitions/occurrences","originalRef":"#/definitions/occurrences"}},"phrases":{"type":"array","description":"A list of occurrence counters for each specific phrase within the tracker (e.g., Amazon, Walmart).","items":{"$ref":"#/definitions/trackerPhrases","originalRef":"#/definitions/trackerPhrases"}},"type":{"type":"string","example":"KEYWORD","description":"The type of the tracker - Keyword or Smart.","enum":["KEYWORD","SMART"]}},"title":"tracker"},"trackerPhrases":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":5,"description":"The number of occurrences of this tracker's value."},"occurrences":{"type":"array","description":"A list of details for each occurrence of the phrase.","items":{"$ref":"#/definitions/occurrences","originalRef":"#/definitions/occurrences"}},"phrase":{"type":"string","example":"Walmart","description":"The specific phrase within the tracker (e.g., Walmart)."}},"title":"trackerPhrases"}}}