Enrichment API

Enrich person information

Enriches person information using LinkedIn URL, email, and other optional details

get/enrich/v1/person

Request

Base URL
https://api.customeros.ai
Auth
API key in header X-CUSTOMER-OS-API-KEY
TypeScript
https://skmtc.dev/customeros/apis/customeros-api/docs/enrich/v1/person/get.ts
A function with typed inputs. Its response is checked against the schema.

linkedinUrlstring

LinkedIn profile URL

emailstring email

Email address

firstNamestring

First name

lastNamestring

Last name

includeMobileNumberboolean

Include mobile number in results

Person not found (status: warning)

messagestring

requestIdstring

statusstring

Status indicates the result of the operation ("success" or "error")

{
  "requestId": "1234567890abcdef",
  "status": "success"
}

Jul 17, 202673526747b270 Revision changes
- info
  added the success response with the status
Sep 10, 202432a769da53f1 Revision changes
- info
  endpoint added