Skip to main content
GET
Get prospect data from prospect email

Authorizations

x-api-key
string
header
required
x-api-secret
string
header
required

Path Parameters

workspaceId
string
required
dynamicId
string
required
contactEmail
string
required

Query Parameters

include
string

Comma-separated list of additional fields to include in the response (emailEmbedHTML, fields)

Response

Successful

contactEmail
string
Example:

"Contact Email, Example: john@example.com"

backgroundUrl
string
Example:

"Backgound URL, Example: https://example.com"

originalBackgroundUrl
string
Example:

"Backgound URL, Example: https://example.com"

status
string
Example:

"Current prospect status, Example: saved, billed, errored, processing, uploaded, completed"

deletedAt
string<date>
Example:

"Deleted Date if prospect was deleted, Example: 2020-01-01T00:00:00.000Z"

valid
boolean
Example:

"False if prospect has validation errors"

createdAt
string<date>
Example:

"Create date, example: 2020-01-01T00:00:00.000Z"

updatedAt
string<date>
Example:

"Update date, example: 2020-01-01T00:00:00.000Z"

validationDetails
object[]
contactName
string
Example:

"Contact Name, example: John Doe"

company
string
Example:

"Company Name, example: Sendspark"

jobTitle
string
Example:

"Job Title, example: Software Engineer"

id
string
Example:

"Internal prospect ID, example: 997f191e810c19729de860fd"

shareUrl
string
Example:

"Public URL to share the final video, example: https://sendspark.com/share/997f191e81"

emailEmbedHTML
string

HTML code for email embedding

fields
object

Additional fields associated with the prospect