Authorizations
Enter your API key as: Bearer your_api_key_here
Body
application/json
Response
Person created
The response is of type object
.
curl --request POST \
--url https://api.stardex.ai/v1/persons \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"linkedin_url": "<string>",
"current_job_title": "<string>",
"linkedin_location": "<string>",
"company_name": "<string>",
"emails": [
"jsmith@example.com"
],
"work_email": "jsmith@example.com",
"work_phone": "<string>",
"personal_email": "jsmith@example.com",
"mobile_phone": "<string>",
"phone_numbers": [
"<string>"
],
"notes": "<string>",
"job_id": "<string>",
"job_name": "<string>",
"client_name": "<string>",
"client_id": "<string>",
"external_source_id": "<string>",
"enrich_record": true
}'
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe",
"linkedin_public_id": "johndoe",
"current_job_title": "Software Engineer",
"company_name": "Tech Corp",
"linkedin_location": "San Francisco, CA",
"emails": [
{
"contact_data_type": "work",
"value": "john@company.com"
}
],
"phones": [
{
"contact_data_type": "mobile",
"value": "+1234567890"
}
],
"candidate_id": "789e0123-e45f-67g8-h901-234567890123",
"client_contact_id": null,
"external_source_id": null
}
}
Create a new person record with contact details and optional job association
curl --request POST \
--url https://api.stardex.ai/v1/persons \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"linkedin_url": "<string>",
"current_job_title": "<string>",
"linkedin_location": "<string>",
"company_name": "<string>",
"emails": [
"jsmith@example.com"
],
"work_email": "jsmith@example.com",
"work_phone": "<string>",
"personal_email": "jsmith@example.com",
"mobile_phone": "<string>",
"phone_numbers": [
"<string>"
],
"notes": "<string>",
"job_id": "<string>",
"job_name": "<string>",
"client_name": "<string>",
"client_id": "<string>",
"external_source_id": "<string>",
"enrich_record": true
}'
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe",
"linkedin_public_id": "johndoe",
"current_job_title": "Software Engineer",
"company_name": "Tech Corp",
"linkedin_location": "San Francisco, CA",
"emails": [
{
"contact_data_type": "work",
"value": "john@company.com"
}
],
"phones": [
{
"contact_data_type": "mobile",
"value": "+1234567890"
}
],
"candidate_id": "789e0123-e45f-67g8-h901-234567890123",
"client_contact_id": null,
"external_source_id": null
}
}
Enter your API key as: Bearer your_api_key_here
Person created
The response is of type object
.
Was this page helpful?