List persons (deprecated)
curl --request GET \
--url https://api.stardex.ai/v1/persons \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stardex.ai/v1/persons"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.stardex.ai/v1/persons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stardex.ai/v1/persons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stardex.ai/v1/persons"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.stardex.ai/v1/persons")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/persons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe",
"linkedin_public_id": "johndoe",
"first_name": "John",
"last_name": "Doe",
"current_job_title": "Software Engineer",
"current_company_name": "Tech Corp",
"current_company_id": "456e7890-e12b-34d5-a678-901234567890",
"external_source_id": null,
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-06-20T14:45:00.000Z",
"image_url": "https://media.samplecdn.com/dms/image/example.jpg",
"location": "San Francisco, CA",
"latitude": 37.7749,
"longitude": -122.4194,
"date_of_last_engagement": "2024-06-18T09:00:00.000Z",
"last_activity_type": "email",
"do_not_contact": false,
"do_not_contact_reason": null,
"owner_id": null,
"emails": [
{
"contact_data_type": "work",
"value": "john@techcorp.com"
}
],
"phones": [
{
"contact_data_type": "mobile",
"value": "+1-555-0123"
}
],
"work_experience": [
{
"company_name": "Tech Corp",
"company_linkedin_url": "https://www.linkedin.com/company/techcorp",
"company_linkedin_id": 12345678,
"company_id": "456e7890-e12b-34d5-a678-901234567890",
"duration_in_months": 36,
"positions": [
{
"title": "Software Engineer",
"start_date": "2022-01-01",
"end_date": null,
"duration_in_months": 36,
"description": "Full-stack development",
"location": "San Francisco, CA",
"position_type": "Full-time"
}
]
}
],
"education_experience": [
{
"company_name": "Stanford University",
"start_date": "2016-09-01",
"end_date": "2020-06-01",
"description": null,
"degree": "B.S. Computer Science",
"company_linkedin_url": "https://www.linkedin.com/school/stanford",
"company_linkedin_id": 1234,
"company_id": null
}
],
"certifications": [
{
"name": "AWS Solutions Architect",
"credential_id": "AWS-SA-001",
"start_date": "2023-06-01",
"end_date": "2026-06-01",
"company_name": "Amazon Web Services",
"company_linkedin_url": null,
"company_linkedin_id": null,
"company_id": null
}
],
"candidates": [
{
"candidate_id": "789e0123-e45f-67a8-b901-234567890123",
"job_name": "Senior Software Engineer",
"job_id": "345e6789-e01b-23c4-d567-890123456789",
"job_client_company_name": "StartupXYZ",
"current_pipeline_stage_name": "Technical Interview",
"current_pipeline_stage_id": "567e8901-e23c-45d6-e789-012345678901",
"is_archived": false,
"created_at": "2024-01-12T14:30:00Z",
"sourced_by": "234e5678-e90a-12b3-c456-789012345678",
"owner_id": null
}
],
"custom_fields": [
{
"attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"attribute_name": "Seniority Level",
"data_type": "single-select",
"value": null,
"tag": {
"id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"name": "Senior"
},
"team_member": null
},
{
"attribute_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"attribute_name": "Years of Experience",
"data_type": "number",
"value": 8,
"tag": null,
"team_member": null
}
],
"activities": [
{
"id": "fff66666-0000-1111-2222-333333336666",
"activity_type": "pipeline_status",
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-01-15T10:00:00Z",
"activity_content": "Moved to Technical Interview",
"team_member": {
"id": "234e5678-e90a-12b3-c456-789012345678",
"name": "Jane Smith"
},
"job": {
"id": "345e6789-e01b-23c4-d567-890123456789",
"title": "Senior Software Engineer",
"company_name": "StartupXYZ"
},
"pipeline_status_details": {
"stage_name": "Technical Interview",
"is_rejection_stage": false,
"entered_at": "2024-01-15T10:00:00Z",
"exited_at": null,
"reason_text": null
}
},
{
"id": "901e2345-e67f-89a0-b123-456789012345",
"activity_type": "secondary_note",
"created_at": "2024-01-14T16:00:00Z",
"updated_at": "2024-01-14T16:45:00Z",
"activity_content": "Great initial call. Strong system design skills.",
"team_member": {
"id": "234e5678-e90a-12b3-c456-789012345678",
"name": "Jane Smith"
},
"job": {
"id": "345e6789-e01b-23c4-d567-890123456789",
"title": "Senior Software Engineer",
"company_name": "StartupXYZ"
}
},
{
"id": "902e3456-f78a-90b1-c234-567890123456",
"activity_type": "email",
"created_at": "2024-01-13T11:00:00Z",
"updated_at": "2024-01-13T11:00:00Z",
"activity_content": "Hi John, following up on our conversation...",
"team_member": {
"id": "234e5678-e90a-12b3-c456-789012345678",
"name": "Jane Smith"
},
"job": {
"id": "345e6789-e01b-23c4-d567-890123456789",
"title": "Senior Software Engineer",
"company_name": "StartupXYZ"
},
"email_details": {
"subject": "Following up — Senior SWE role",
"from_email": "jane@startup.xyz",
"to_email": "john@techcorp.com",
"status": "sent"
}
}
],
"compensation": [
{
"id": "678e9012-e34d-56f7-a890-123456789012",
"compensation_type": "actual",
"currency_code": "USD",
"current_compensation_base": 180000,
"current_compensation_bonus": 20000,
"equity_percent": null,
"equity_amount": 50000,
"compensation_year": 2024,
"total_estimated_compensation": 250000,
"note": "Current package at Tech Corp",
"job_id": null,
"job_name": null,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"related_people": [
{
"relation_id": "rel-1111-2222-3333-444444444444",
"person_id": "567e8901-e23c-45d6-e789-012345678901",
"name": "Jane Smith",
"current_job_title": "Engineering Manager",
"linkedin_public_id": "janesmith",
"current_company_name": "Tech Corp",
"current_company_id": "456e7890-e12b-34d5-a678-901234567890",
"relation_type": "colleague",
"note": "Worked together on Platform team",
"direction": "outgoing",
"created_at": "2024-01-05T10:00:00Z"
}
],
"offers": [
{
"id": "offer-1111-2222-3333-444444444444",
"job_id": "345e6789-e01b-23c4-d567-890123456789",
"job_name": "Senior Software Engineer",
"job_company_name": "StartupXYZ",
"candidate_id": "789e0123-e45f-67a8-b901-234567890123",
"status": {
"id": "status-1111",
"name": "Extended",
"color": "#22c55e"
},
"extended_date": "2024-02-01T00:00:00Z",
"accepted_date": null,
"candidate_start_date": "2024-03-01T00:00:00Z",
"compensation_currency": "USD",
"compensation_base": 200000,
"compensation_bonus": 30000,
"bonus_type": "fixed",
"annual_equity_grant_percent": null,
"annual_equity_grant_amount": 50000,
"initial_equity_grant_percent": null,
"initial_equity_grant_amount": 100000,
"relocation_bonus": 10000,
"total_estimated_compensation": 290000,
"note": "Competitive offer with strong equity component",
"created_at": "2024-02-01T00:00:00Z",
"updated_at": "2024-02-01T00:00:00Z"
}
]
}
],
"meta": {
"total": 100,
"offset": 0,
"limit": 20
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Persons
List persons (deprecated)
deprecated
Deprecated — Use POST /v1/persons/search instead for full filtering, sorting, and include control.
Retrieve a paginated list of ALL persons with optional sorting — no filtering.
Pagination: Use offset and limit query params (max 100 per page).
Sorting: Set sort_by to one of: name, created_at, updated_at, current_job_title, company, location, date_of_last_engagement, person_owner, last_activity_type, contact_email, or custom_<attribute_id> for custom fields. Use sort_order (asc or desc, default desc).
Include control: The include query param accepts a comma-separated list of section names. Allowed values: work_experience, education_experience, certifications, candidates, custom_fields, activities, compensation, related_people, offers. When omitted, defaults to work_experience, education_experience, certifications. Pass an empty string to return only base fields.
API-key scope requirements: Requests missing a required scope succeed with inaccessible include sections omitted: activities requires notes:read, candidates requires candidates:read, and compensation and offers require compensation:read.
GET
/
v1
/
persons
List persons (deprecated)
curl --request GET \
--url https://api.stardex.ai/v1/persons \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stardex.ai/v1/persons"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.stardex.ai/v1/persons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stardex.ai/v1/persons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stardex.ai/v1/persons"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.stardex.ai/v1/persons")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/persons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe",
"linkedin_public_id": "johndoe",
"first_name": "John",
"last_name": "Doe",
"current_job_title": "Software Engineer",
"current_company_name": "Tech Corp",
"current_company_id": "456e7890-e12b-34d5-a678-901234567890",
"external_source_id": null,
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-06-20T14:45:00.000Z",
"image_url": "https://media.samplecdn.com/dms/image/example.jpg",
"location": "San Francisco, CA",
"latitude": 37.7749,
"longitude": -122.4194,
"date_of_last_engagement": "2024-06-18T09:00:00.000Z",
"last_activity_type": "email",
"do_not_contact": false,
"do_not_contact_reason": null,
"owner_id": null,
"emails": [
{
"contact_data_type": "work",
"value": "john@techcorp.com"
}
],
"phones": [
{
"contact_data_type": "mobile",
"value": "+1-555-0123"
}
],
"work_experience": [
{
"company_name": "Tech Corp",
"company_linkedin_url": "https://www.linkedin.com/company/techcorp",
"company_linkedin_id": 12345678,
"company_id": "456e7890-e12b-34d5-a678-901234567890",
"duration_in_months": 36,
"positions": [
{
"title": "Software Engineer",
"start_date": "2022-01-01",
"end_date": null,
"duration_in_months": 36,
"description": "Full-stack development",
"location": "San Francisco, CA",
"position_type": "Full-time"
}
]
}
],
"education_experience": [
{
"company_name": "Stanford University",
"start_date": "2016-09-01",
"end_date": "2020-06-01",
"description": null,
"degree": "B.S. Computer Science",
"company_linkedin_url": "https://www.linkedin.com/school/stanford",
"company_linkedin_id": 1234,
"company_id": null
}
],
"certifications": [
{
"name": "AWS Solutions Architect",
"credential_id": "AWS-SA-001",
"start_date": "2023-06-01",
"end_date": "2026-06-01",
"company_name": "Amazon Web Services",
"company_linkedin_url": null,
"company_linkedin_id": null,
"company_id": null
}
],
"candidates": [
{
"candidate_id": "789e0123-e45f-67a8-b901-234567890123",
"job_name": "Senior Software Engineer",
"job_id": "345e6789-e01b-23c4-d567-890123456789",
"job_client_company_name": "StartupXYZ",
"current_pipeline_stage_name": "Technical Interview",
"current_pipeline_stage_id": "567e8901-e23c-45d6-e789-012345678901",
"is_archived": false,
"created_at": "2024-01-12T14:30:00Z",
"sourced_by": "234e5678-e90a-12b3-c456-789012345678",
"owner_id": null
}
],
"custom_fields": [
{
"attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"attribute_name": "Seniority Level",
"data_type": "single-select",
"value": null,
"tag": {
"id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"name": "Senior"
},
"team_member": null
},
{
"attribute_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"attribute_name": "Years of Experience",
"data_type": "number",
"value": 8,
"tag": null,
"team_member": null
}
],
"activities": [
{
"id": "fff66666-0000-1111-2222-333333336666",
"activity_type": "pipeline_status",
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-01-15T10:00:00Z",
"activity_content": "Moved to Technical Interview",
"team_member": {
"id": "234e5678-e90a-12b3-c456-789012345678",
"name": "Jane Smith"
},
"job": {
"id": "345e6789-e01b-23c4-d567-890123456789",
"title": "Senior Software Engineer",
"company_name": "StartupXYZ"
},
"pipeline_status_details": {
"stage_name": "Technical Interview",
"is_rejection_stage": false,
"entered_at": "2024-01-15T10:00:00Z",
"exited_at": null,
"reason_text": null
}
},
{
"id": "901e2345-e67f-89a0-b123-456789012345",
"activity_type": "secondary_note",
"created_at": "2024-01-14T16:00:00Z",
"updated_at": "2024-01-14T16:45:00Z",
"activity_content": "Great initial call. Strong system design skills.",
"team_member": {
"id": "234e5678-e90a-12b3-c456-789012345678",
"name": "Jane Smith"
},
"job": {
"id": "345e6789-e01b-23c4-d567-890123456789",
"title": "Senior Software Engineer",
"company_name": "StartupXYZ"
}
},
{
"id": "902e3456-f78a-90b1-c234-567890123456",
"activity_type": "email",
"created_at": "2024-01-13T11:00:00Z",
"updated_at": "2024-01-13T11:00:00Z",
"activity_content": "Hi John, following up on our conversation...",
"team_member": {
"id": "234e5678-e90a-12b3-c456-789012345678",
"name": "Jane Smith"
},
"job": {
"id": "345e6789-e01b-23c4-d567-890123456789",
"title": "Senior Software Engineer",
"company_name": "StartupXYZ"
},
"email_details": {
"subject": "Following up — Senior SWE role",
"from_email": "jane@startup.xyz",
"to_email": "john@techcorp.com",
"status": "sent"
}
}
],
"compensation": [
{
"id": "678e9012-e34d-56f7-a890-123456789012",
"compensation_type": "actual",
"currency_code": "USD",
"current_compensation_base": 180000,
"current_compensation_bonus": 20000,
"equity_percent": null,
"equity_amount": 50000,
"compensation_year": 2024,
"total_estimated_compensation": 250000,
"note": "Current package at Tech Corp",
"job_id": null,
"job_name": null,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"related_people": [
{
"relation_id": "rel-1111-2222-3333-444444444444",
"person_id": "567e8901-e23c-45d6-e789-012345678901",
"name": "Jane Smith",
"current_job_title": "Engineering Manager",
"linkedin_public_id": "janesmith",
"current_company_name": "Tech Corp",
"current_company_id": "456e7890-e12b-34d5-a678-901234567890",
"relation_type": "colleague",
"note": "Worked together on Platform team",
"direction": "outgoing",
"created_at": "2024-01-05T10:00:00Z"
}
],
"offers": [
{
"id": "offer-1111-2222-3333-444444444444",
"job_id": "345e6789-e01b-23c4-d567-890123456789",
"job_name": "Senior Software Engineer",
"job_company_name": "StartupXYZ",
"candidate_id": "789e0123-e45f-67a8-b901-234567890123",
"status": {
"id": "status-1111",
"name": "Extended",
"color": "#22c55e"
},
"extended_date": "2024-02-01T00:00:00Z",
"accepted_date": null,
"candidate_start_date": "2024-03-01T00:00:00Z",
"compensation_currency": "USD",
"compensation_base": 200000,
"compensation_bonus": 30000,
"bonus_type": "fixed",
"annual_equity_grant_percent": null,
"annual_equity_grant_amount": 50000,
"initial_equity_grant_percent": null,
"initial_equity_grant_amount": 100000,
"relocation_bonus": 10000,
"total_estimated_compensation": 290000,
"note": "Competitive offer with strong equity component",
"created_at": "2024-02-01T00:00:00Z",
"updated_at": "2024-02-01T00:00:00Z"
}
]
}
],
"meta": {
"total": 100,
"offset": 0,
"limit": 20
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Authenticate with a Bearer token: API key, OAuth token, or session token.
Query Parameters
Records to skip for pagination. Defaults to 0.
Required range:
x >= 0Max records per page (1–100). Defaults to 100.
Required range:
1 <= x <= 100Sort column. Values: name, created_at, updated_at, current_job_title, company, location, date_of_last_engagement, person_owner, last_activity_type, contact_email, or custom_<attribute_id> for custom fields. Defaults to created_at.
Example:
"created_at"
Sort direction. Defaults to desc (newest first).
Available options:
asc, desc Comma-separated sections to embed in each person. Values: work_experience, education_experience, certifications, candidates, custom_fields, activities, compensation, related_people, offers. Default: work_experience, education_experience, certifications. Pass empty string for base fields only (id, name, emails, phones, etc.). For API-key callers, unavailable requested sections are omitted: activities requires notes:read, candidates requires candidates:read, and compensation and offers require compensation:read.
Example:
"work_experience,candidates,custom_fields"
Was this page helpful?
⌘I