Skip to content

Public Enrich Lookup

POST
/public/enrich/lookup

Look up a contact by email using write key authentication.

Used by the progressive form component to determine which fields graph8 already knows (and can hide) vs which fields to ask the user.

Searches the mashup (OpenSearch) index for enrichment data.

Authorizations

Parameters

Header Parameters

X-Write-Key
Any of:
string

Request Body required

object
email
required

Email address to look up

string

Responses

200

Successful Response

object
data
required
object
found
required

Whether the email was found in graph8

boolean
known_fields

Fields graph8 already knows

object
key
additional properties
any
missing_fields

Fields the form should ask for

Array<string>
default:
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string