Skip to content

Gets an enrichment query

GET
/v1/enrichments/{id}

Provide a query ID and the endpoint will return the query status. Once the query is completed, the response will also include the enrichment results. The query might take a few seconds to complete, we recommend polling this endpoint around once every second.

Authorizations

Parameters

Path Parameters

id
required
string

Enrichment ID

Responses

200

Response

object
emails
Array<object>
object
email
string
validationStatus
string
errors
Array<object>
object
error
string
type
string
expiresAt
string
id
string
landlines
Array<object>
object
landline
string
mobilePhones
Array<object>
object
mobilePhone
string
status
string
Allowed values: IN_PROGRESS COMPLETED

400

Invalid request

object
code
integer
message
string

401

Missing or wrong API key

object
code
integer
message
string

403

Only paid users may use the public API, please contact support if you need help

object
code
integer
message
string

404

No enrichments found with this ID

object
code
integer
message
string

500

Failed to process request, please try again or contact customer support if you need help

object
code
integer
message
string