Skip to main content
GET
/
v1
/
persons
List persons (deprecated)
curl --request GET \
  --url https://api.stardex.ai/v1/persons \
  --header 'Authorization: Bearer <token>'
{
  "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,
      "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",
          "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",
          "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",
          "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": "comp-1111-2222-3333-444444444444",
          "compensation_type": "actual",
          "currency_code": "USD",
          "current_compensation_base": 180000,
          "current_compensation_bonus": 20000,
          "annual_equity_grant_percent": null,
          "annual_equity_grant_amount": 50000,
          "initial_equity_grant_percent": null,
          "initial_equity_grant_amount": null,
          "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
  }
}

Authorizations

​
Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Query Parameters

​
offset
integer | null
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
​
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

Required range: 1 <= x <= 100
​
sort_by
string

Sort column. Values: name, created_at, updated_at, current_job_title, company, linkedin_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_order
enum<string>
default:desc

Sort direction. Defaults to desc (newest first).

Available options:
asc,
desc
​
include
string

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.).

Example:

"work_experience,candidates,custom_fields"

Response

Successful response

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required
​
meta
object
required