.mint-block {
    display: block
}
.mint-hidden {
    display: none
}
.dark\:mint-block:is(.dark *) {
    display: block
}
.dark\:mint-hidden:is(.dark *) {
    display: none
}

Welcome to Stardex's help documentation and API reference

Introduction

Authorization

Stardex Help Docs

Development

Custom fields

New file

Use this feature to track the progress of your market mapping efforts when sourcing candidates for a role.

Target companies

Easily keep clients updated on your pipeline without requiring them to create an account in Stardex. You can pick which candidates, attributes, and notes you want to share and Stardex will automatically keep this synced. Clients can also leave feedback for your team.

Sharable link

Returns person details by LinkedIn URL or ID

Get person details

Creates a new person record with comprehensive profile information.
      - Creates associated work experience if company and job title provided
      - Links person to job/candidate if job details provided
      - Links person as client contact if client details provided
      - Handles multiple contact details (emails/phones)
      - Creates initial notes if provided

Create a new person

Search for persons using various criteria:
    - Email/Phone search: Exact match, returns all matching persons
    - Name search: Partial match (case-insensitive), returns up to 20 results
    - At least one search parameter (email, phone, or name) must be provided
    - Results include basic person details and all associated contact information

Search for persons

Updates a person's information including contact details and professional information.
      - Contact details (emails/phones) are upserted - existing records are updated, new ones are added
      - Professional details are updated if provided
      - All fields are optional - only provided fields will be updated

Update person details

Add a person activity

Retrieves a person activity by ID with its content in both HTML and raw text formats

Get a person activity

Updates the content of an existing person activity. 
    Supports both plain text and HTML content formats.
    
    - For plain text, the content will be wrapped in a paragraph structure
    - For HTML, the content will be parsed and converted to the appropriate format while preserving formatting
    
    The activity must belong to the authenticated organization and team.

Get Started

General setup

Introduction