Enrich person information - CustomerOS Docs

GET

enrich

person

curl --request GET \
  --url https://api.customeros.ai/enrich/v1/person \
  --header 'X-CUSTOMER-OS-API-KEY: <api-key>'

{
  "message": "<string>",
  "requestId": "1234567890abcdef",
  "status": "success"
}

X-CUSTOMER-OS-API-KEY

string

header

required

linkedinUrl

string

LinkedIn profile URL

string

Email address

firstName

string

First name

Minimum length: 1

lastName

string

Last name

Minimum length: 1

includeMobileNumber

boolean

default:false

Include mobile number in results

200

application/json

Person not found (status: warning)

message

string

requestId

string

Example:

"1234567890abcdef"

status

string

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

Example:

"success"

curl --request GET \
  --url https://api.customeros.ai/enrich/v1/person \
  --header 'X-CUSTOMER-OS-API-KEY: <api-key>'

{
  "message": "<string>",
  "requestId": "1234567890abcdef",
  "status": "success"
}