Research contacts
Research contacts by searchResultId from contact search results or Contact enrich.
Credits: each contact is charged for the components it researches, at the prices in Credits. researchTypes defaults to email and phone, or to your Contact Data setting if it’s set to emails or phones only. Credits for data that isn’t found are refunded. The request is rejected with a 422 when your balance can’t cover every contact, priced at the most it can cost.
curl --request POST \
--url https://api.seamless.ai/api/client/v1/contacts/research \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"searchResultIds": [
"708dbb34-3849-3c06-abd1-238b9a0295b3",
"3f2c9a71-6b4e-3d8a-9c15-7e0b4d2a6f83"
]
}
'{
"success": true,
"requestIds": [
"6Ei5iKuSHzJXvqjVPWiZ_"
]
}{
"msg": "<string>",
"code": "<string>"
}{
"msg": "<string>",
"code": "<string>"
}{
"msg": "<string>",
"code": "<string>"
}{
"msg": "<string>",
"code": "<string>",
"data": {
"productCategory": "<string>",
"additionalCreditsNeeded": 123
}
}{
"msg": "<string>",
"code": "<string>"
}Authorizations
Body
Array of search result IDs obtained from a prior /search/contacts call. Each ID triggers a contact research request, charged for the components it researches (see researchTypes and Credits). Intended as an alternative to the contacts property; if both are sent, their combined length must not exceed 500.
500[
"11ad7a1c-9a63-30e0-a1de-cd9a766805ca",
"22bd8b2d-0b74-41f1-b2ef-de0ab877916db"
]
Contact enrich request. Provide an array of contacts to research by identity. Each item must include one of the following combinations:
- contactName and companyName (optionally include title when using isJobChange)
- contactName and domain
- liProfileUrl
- liSalesNavUrl
- liRecruiterUrl
Intended as an alternative to searchResultIds; if both are sent, their combined length must not exceed 500. When isJobChange is true, only the contacts array should be used. Each contact is charged the same way as a searchResultId.
500Show child attributes
Show child attributes
IDs of the contact lists to add each newly saved contact to. Contacts that were already researched are not saved again, so they are not added to the lists. The lists must already belong to the authenticated user; an unknown ID fails the research request items, which report the error when you poll for them.
50[1234, 5678]
When true, research skips both duplicate checks and researches the record again, which charges credits again.
By default a request is reported as duplicate when the same record was researched in the last few minutes, and as contact-already-researched when the contact is already saved in your My Contacts. Within those few minutes, a request for contact data the earlier research didn't get (for example phone after an email-only research) is researched onto that contact instead, and only the new data is charged. Repeated IDs within a single request are always collapsed into one research request.
Optional. Defaults to ["email", "phone"], or to the user's Contact Data setting if it's set to emails or phones only. Applies to every contact in the request, including contact details and job changes.
Send ["email"], ["phone"], or ["email", "phone"] (Full Contact). Order doesn't matter, duplicates are removed, and null is the same as leaving it out.
Each component is charged at its price. See Credits for the default prices, custom pricing and refunds.
Rejected with:
- 400
invalidArgumentswhen it isn't a non-empty array ofemailand/orphone - 403
fullContactRequiredwhen your organization's Contact Data is locked to Full Contact and you send one component - 403
component-disabled-for-orgwhen your organization disabled a component you sent - 403
variable-credits-disabledwhen your account isn't on component-based pricing and you send one component
1email, phone ["email"]
Response
The request IDs for research
Was this page helpful?
curl --request POST \
--url https://api.seamless.ai/api/client/v1/contacts/research \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"searchResultIds": [
"708dbb34-3849-3c06-abd1-238b9a0295b3",
"3f2c9a71-6b4e-3d8a-9c15-7e0b4d2a6f83"
]
}
'{
"success": true,
"requestIds": [
"6Ei5iKuSHzJXvqjVPWiZ_"
]
}{
"msg": "<string>",
"code": "<string>"
}{
"msg": "<string>",
"code": "<string>"
}{
"msg": "<string>",
"code": "<string>"
}{
"msg": "<string>",
"code": "<string>",
"data": {
"productCategory": "<string>",
"additionalCreditsNeeded": 123
}
}{
"msg": "<string>",
"code": "<string>"
}