Documentation Index

Fetch the complete documentation index at: https://help.gong.io/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve all references to an email address. (/v2/data-privacy/data-for-email-address)

Prev Next
Get
/v2/data-privacy/data-for-email-address

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.

Required authorizaton scope: 'api:data-privacy:read'.

Query parameters
emailAddress
stringRequired

The email address.

Responses
200

Successful request

Expand All
object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
emails
Array of object (EmailMessage)

Related email messages.

object

Related email messages.

from
string

The sender's email address.

Exampletest@test.com
id
string

Gong's unique 32 character identifier for the email message.

Example223mjfaaqqjuegabiyrmpctvcwwl75oz
sentTime
string

The date and time the email message was sent in the ISO-8601 format, for example: '2024-01-17T16:20:05-03:00' or '2016-02-16T03:57:04.834+05:30' or '2020-11-20T21:30:07.233692Z', where Z stands for UTC.

Example2019-01-20T00:00:00-08:00
mailbox
string

The mailbox from which the email was retrieved.

Exampletest@test.com
messageHash
string

Hash code of the email message.

Examplel3z7w2s7oircdabnkwizmycm6g2uwznc
calls
Array of object (CallReference)

Related calls.

object

Details of a call referencing the email address.

id
string

Gong's unique numeric identifier for the call (up to 20 digits).

Example7782342274025937895
status
string

Call status

ExampleCOMPLETED
externalSystems
Array of object (ExternalSystem)

A list of links to external systems such as CRM, Telephony System, Case Management, etc.

object

A list of links to external systems such as CRM, Telephony System, Case Management, etc.

system
string

External system name.

Valid values[ "Salesforce", "HubSpot", "MicrosoftDynamic", "Generic" ]
ExampleSalesforce
objects
Array of object (ExternalSystemObject)

List of objects within the external system.

object

List of objects within the external system.

objectType
string

Object Type.

Valid values[ "Conversation", "Task" ]
ExampleTask
externalId
string

External ID.

Example0013601230sV7grAAC
meetings
Array of object (Meeting)

Related meetings.

object

Related meetings.

id
string

Gong's unique identifier for the meeting.

Example8059707022269524529.sb5gr1tgpt5dd799eh035rb3dk@google.com_2022-06-30T13:00:00Z
customerData
Array of object (CustomerData)

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.

object

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.

system
string

External system name.

Valid values[ "Salesforce", "HubSpot", "MicrosoftDynamic", "Generic" ]
ExampleSalesforce
objects
Array of object (CustomerDataObject)

List of objects in the external system.

object

List of objects in the external system.

id
string

Gong's unique numeric identifier (up to 20 digits) for the Lead or Contact.

Example7782342274025937895
objectType
string

Object Type.

Valid values[ "Lead", "Contact" ]
ExampleContact
externalId
string

External ID.

Example0013601230sV7grAAC
mirrorId
string

Crm Mirror ID.

Example"{\"integrationId\":\"262834820328732\",\"crmObjectType\":\"CONTACT\",\"crmId\":\"0031Q00002DFhi4QAD\"}"
fields
Array of object (ContextField)

Object fields.

object

External object data

name
string

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.

Examplename
value
object

Field value

ExampleGong Inc.
customerEngagement
Array of object (CustomerEngagement)

A list of customer's engagement (such as viewing external share call)

object

A list of customer's engagement (such as viewing external share call)

eventType
string

Event type

Valid values[ "contentShared", "contentViewed", "customEvent", "digitalInteraction" ]
ExampleExternalCallViewing
timestamp
string (date-time)

The date and time the event occurred in the ISO-8601 format, for example: '2024-01-17T16:20:05-03:00' or '2016-02-16T03:57:04.834+05:30' or '2020-11-20T21:30:07.233692Z', where Z stands for UTC.

Example2019-01-20T08:00:00Z
contentId
string

Event content id

Example7782342274025937895
contentUrl
string

Event content url

Examplehttps://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i
reportingSystem
string

Event reporting system

Examplehttps://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i
eventName
string

Event name

Examplehttps://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i
sourceEventId
string

Source event Id

Examplehttps://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i
400

Malformed request

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
401

Access denied

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
429

API request limit exceeded

Headers
Retry-After
integer
Number of seconds to wait before making a new request.
object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
500

Failed to complete the operation due to an unexpected error

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string