# Stardex Help Docs

> AI native ATS & CRM for search firms

## Docs

- [Get calendar meeting by ID](https://docs.stardex.com/api-reference/calendar-meetings/get-calendar-meeting-by-id.md): Retrieve detailed information about a specific calendar meeting including all associated recordings and their processing status.
- [List calendar meetings](https://docs.stardex.com/api-reference/calendar-meetings/list-calendar-meetings.md): Retrieve a paginated list of calendar meetings tracked by the notetaker.
- [Get candidate by ID](https://docs.stardex.com/api-reference/candidates/get-candidate-by-id.md): Retrieve detailed information about a single candidate including their full pipeline stage history (all stages they have been through with dates).
- [Update candidate stage](https://docs.stardex.com/api-reference/candidates/update-candidate-stage.md): Moves a candidate to a different pipeline stage within a job.
- [List client contact statuses](https://docs.stardex.com/api-reference/client-contacts/list-client-contact-statuses.md): Returns all client contact statuses for the organization, ordered by stage_order. No pagination — the full list is always returned.
- [Update client contact status](https://docs.stardex.com/api-reference/client-contacts/update-client-contact-status.md): Update a client contact's status. Pass a valid status UUID to change the status, or null to clear it.
- [Create or update company](https://docs.stardex.com/api-reference/companies/create-or-update-company.md): Create a new company record or update an existing one. Matching is done by LinkedIn URL, domain, or name. At least one of name, domain, or linkedin_url must be provided.
- [Get company by ID](https://docs.stardex.com/api-reference/companies/get-company-by-id.md): Retrieve detailed information about a specific company including client status, owners, enriched data, and custom field values. Custom fields are included by default; pass `include=` (empty) for base fields only.
- [List company client statuses](https://docs.stardex.com/api-reference/companies/list-company-client-statuses.md): Returns all company client statuses for the organization, ordered by stage_order. No pagination — the full list is always returned.
- [Search companies](https://docs.stardex.com/api-reference/companies/search-companies.md): Advanced company search with filtering, sorting, and custom attribute filters.
- [Update company](https://docs.stardex.com/api-reference/companies/update-company.md): Update an existing company's information including name, domain, description, and custom field values. Only provided fields are updated; omitted fields remain unchanged.
- [Get company custom field definitions](https://docs.stardex.com/api-reference/custom-fields/get-company-custom-field-definitions.md): Retrieve custom attribute definitions for companies, including available tag options.
- [Get deal custom field definitions](https://docs.stardex.com/api-reference/custom-fields/get-deal-custom-field-definitions.md): Retrieve custom attribute definitions for deals, including available tag options.
- [Get job custom field definitions](https://docs.stardex.com/api-reference/custom-fields/get-job-custom-field-definitions.md): Retrieve custom attribute definitions for jobs, including available tag options.
- [Get person custom field definitions](https://docs.stardex.com/api-reference/custom-fields/get-person-custom-field-definitions.md): Retrieve custom attribute definitions for persons, including available tag options for select-type fields.
- [Create deal](https://docs.stardex.com/api-reference/deals/create-deal.md): Create a new deal record. Provide `client_linkedin_url` to automatically look up or create the client company when `client_id` is not known.
- [Delete deal](https://docs.stardex.com/api-reference/deals/delete-deal.md): Soft-delete a deal by marking it as deleted. The record is not physically removed.
- [Get deal by ID](https://docs.stardex.com/api-reference/deals/get-deal-by-id.md): Retrieve a single deal by UUID with optional custom field values.
- [List deal statuses](https://docs.stardex.com/api-reference/deals/list-deal-statuses.md): Returns all deal statuses for the organization, ordered by stage_order. No pagination — the full list is always returned.
- [Search deals](https://docs.stardex.com/api-reference/deals/search-deals.md): Search and filter deals with pagination and sorting using the deals_list_query RPC.
- [Update deal](https://docs.stardex.com/api-reference/deals/update-deal.md): Update an existing deal. Only provided fields are modified; omitted fields remain unchanged.
- [Introduction](https://docs.stardex.com/api-reference/introduction-v1.md): Get started with the Stardex API
- [Create job](https://docs.stardex.com/api-reference/jobs/create-job.md): Create a new job with company association, pipeline template, and team member assignments. The company will be matched or created automatically based on the identifiers provided. Background AI tasks (candidate search, criteria generation) are triggered after creation.
- [Get job by ID](https://docs.stardex.com/api-reference/jobs/get-job-by-id.md): Retrieve detailed information about a specific job including pipeline stages, team members with roles, candidate count, and custom field values.
- [List job candidates](https://docs.stardex.com/api-reference/jobs/list-job-candidates.md): Retrieve a paginated list of ALL candidates in a specific job — no filtering.
- [List job team member roles](https://docs.stardex.com/api-reference/jobs/list-job-team-member-roles.md): Retrieve all job team member roles for the current team. Use the returned `id` values when filtering by `team_member_role_ids` in `POST /v1/jobs/search` or `POST /v1/persons/search`.
- [List jobs (deprecated)](https://docs.stardex.com/api-reference/jobs/list-jobs-deprecated.md): **Deprecated** — Use `POST /v1/jobs/search` instead for full filtering, sorting, and vector search.
- [Search jobs](https://docs.stardex.com/api-reference/jobs/search-jobs.md): Advanced job search with filtering, sorting, and vector search. Supports all filter types: keywords, location, job status, companies, team members/roles, custom attributes (select, numeric, date, team member), and semantic vector search.
- [Get meeting recording by ID](https://docs.stardex.com/api-reference/meeting-recordings/get-meeting-recording-by-id.md): Retrieve detailed information about a specific meeting recording including the associated calendar meeting details and full transcript text.
- [List meeting recordings](https://docs.stardex.com/api-reference/meeting-recordings/list-meeting-recordings.md): Retrieve a paginated list of meeting recordings with optional filters.
- [Create person activity](https://docs.stardex.com/api-reference/person-activities/create-person-activity.md): Create a new activity (note, meeting, email, etc.) and attach it to a person record. The person can be identified by `person_id`, `email`, `linkedin_url`, or `full_name` — at least one is required.
- [Get person activity by ID](https://docs.stardex.com/api-reference/person-activities/get-person-activity-by-id.md): Retrieve a single person activity by its UUID. Returns content in both HTML and plain text formats.
- [Update person activity by ID](https://docs.stardex.com/api-reference/person-activities/update-person-activity-by-id.md): Update the content of an existing person activity. Set `content_type` to `"text"` for plain text (auto-converted to HTML) or `"html"` for raw HTML input.
- [Advanced person search](https://docs.stardex.com/api-reference/persons/advanced-person-search.md): The primary tool for finding and filtering persons across the entire database. All filters are optional and combinable. Use this instead of list-persons for any filtered query.
- [Create person](https://docs.stardex.com/api-reference/persons/create-person.md): Create a new person record with contact details and optional job association. Returns the created person with IDs for further operations.
- [Get person by ID](https://docs.stardex.com/api-reference/persons/get-person-by-id.md): Retrieve detailed information about a specific person by their UUID.
- [Get person documents](https://docs.stardex.com/api-reference/persons/get-person-documents.md): Retrieve a paginated list of documents (resumes, cover letters, etc.) for a person. Each document includes a short-lived signed download URL that expires in minutes — re-fetch if the link expires.
- [Get unified person activities](https://docs.stardex.com/api-reference/persons/get-unified-person-activities.md): Retrieve a unified, paginated timeline of all activities for a person. Aggregates notes, emails, tasks, calendar events, sequence enrollments, pipeline stage changes, and assessments. Supports filtering by activity type, team member, job, date range (created_at_gte / created_at_lte), and text search…
- [List persons (deprecated)](https://docs.stardex.com/api-reference/persons/list-persons-deprecated.md): **Deprecated** — Use `POST /v1/persons/search` instead for full filtering, sorting, and include control.
- [Update person](https://docs.stardex.com/api-reference/persons/update-person.md): Update an existing person's information including contact details, job title, company, do-not-contact status, and custom field values. Only provided fields are updated; omitted fields remain unchanged.
- [Upload person document](https://docs.stardex.com/api-reference/persons/upload-person-document.md): Upload a document (resume, cover letter, etc.) for a person. Supports two modes:
- [Create task](https://docs.stardex.com/api-reference/tasks/create-task.md): Create a new task with required content and type. Optionally associate with a person, deal, client, or job.
- [Delete task](https://docs.stardex.com/api-reference/tasks/delete-task.md): Permanently delete a task by its UUID.
- [Get task by ID](https://docs.stardex.com/api-reference/tasks/get-task-by-id.md): Retrieve a single task by its UUID, including owner information.
- [Search tasks](https://docs.stardex.com/api-reference/tasks/search-tasks.md): Search and filter tasks with pagination and sorting.
- [Update task](https://docs.stardex.com/api-reference/tasks/update-task.md): Update an existing task. Only provided fields are modified; omitted fields remain unchanged.
- [Get team member by ID](https://docs.stardex.com/api-reference/team-members/get-team-member-by-id.md): Retrieve a single team member by UUID. Useful for resolving team member IDs from webhook payloads (e.g. `sourced_by_team_member`, `last_stage_updated_by`, `owner_id`).
- [List team members](https://docs.stardex.com/api-reference/team-members/list-team-members.md): Retrieve a paginated list of team members (recruiters and staff). Supports filtering by active status, first name, last name, and email address.
- [Get webhook management portal URL](https://docs.stardex.com/api-reference/webhooks/get-webhook-management-portal-url.md): Returns a Svix App Portal magic link URL for the current team. Embed in an iframe or open directly for endpoint management, delivery logs, and replay.

## OpenAPI Specs

- [openapi-v1](https://docs.stardex.com/api-reference/openapi-v1.json)
- [openapi](https://docs.stardex.com/api-reference/openapi.json)
- [openapi-zapier](https://docs.stardex.com/api-reference/openapi-zapier.json)

## Optional

- [Home page](https://www.stardex.com)
- [Blog](https://www.stardex.com/blog)