Skip to main content
POST
/
v1
/
jobs
Create job
curl --request POST \
  --url https://api.stardex.ai/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "company_name": "<string>",
  "company_domain": "<string>",
  "company_linkedin_url": "<string>",
  "pipeline_template_name": "<string>",
  "team_members": [
    {
      "team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team_member_email": "<string>",
      "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role_name": "<string>"
    }
  ],
  "job_description": "<string>",
  "location": "<string>",
  "primary_url": "<string>",
  "currency_code": "<string>",
  "job_function": "<string>",
  "open_date": "<string>",
  "end_date": "<string>",
  "salary_min": 1,
  "salary_max": 1,
  "fee": 1,
  "firm_commission_percent": 50
}
'
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Senior Software Engineer",
    "created_at": "2024-01-10T09:00:00Z",
    "is_archived": false,
    "client_company_name": "StartupXYZ",
    "client_company_id": "456e7890-e12b-34d5-a678-901234567890",
    "client_company_domain": "startupxyz.com",
    "client_company_linkedin_url": "https://www.linkedin.com/company/startupxyz",
    "job_status_name": "Active",
    "job_status_id": "789e0123-e45f-67g8-h901-234567890123",
    "candidate_count": 12,
    "location": "San Francisco, CA",
    "primary_url": "https://startupxyz.com/careers/senior-software-engineer",
    "job_function": "Engineering",
    "open_date": "2024-01-01",
    "end_date": "2024-03-01",
    "currency_code": "USD",
    "salary_range": "[150000,200000]",
    "team_members": [
      {
        "team_member_id": "234e5678-e90a-12b3-c456-789012345678",
        "email": "jane@company.com",
        "first_name": "Jane",
        "last_name": "Smith",
        "image_url": null,
        "role_id": "345e6789-e01b-23c4-d567-890123456789",
        "role_name": "Team Lead"
      }
    ],
    "pipeline_stages": [
      {
        "id": "345e6789-e01b-23c4-d567-890123456789",
        "name": "Application Review",
        "stage_order": 1,
        "is_rejection_stage": false,
        "is_interviewing_stage": false
      },
      {
        "id": "567e8901-e23c-45d6-e789-012345678901",
        "name": "Technical Interview",
        "stage_order": 2,
        "is_rejection_stage": false,
        "is_interviewing_stage": true
      },
      {
        "id": "789e0123-e45f-67g8-h901-234567890123",
        "name": "Final Interview",
        "stage_order": 3,
        "is_rejection_stage": false,
        "is_interviewing_stage": true
      },
      {
        "id": "901e2345-e67f-89g0-h123-456789012345",
        "name": "Offer",
        "stage_order": 4,
        "is_rejection_stage": false,
        "is_interviewing_stage": false
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Enter your API key as: Bearer your_api_key_here

Body

application/json
title
string
required

Job title. Example: "Senior Software Engineer"

Minimum string length: 1
company_name
string

Client company name. At least one of company_name, company_domain, or company_linkedin_url is required.

company_domain
string

Client company website domain (e.g. "acme.com"). Used for matching or creating the company record.

company_linkedin_url
string<uri>

Client company LinkedIn URL (e.g. "https://linkedin.com/company/acme").

pipeline_template_name
string

Name of the pipeline template to use. Defaults to "Default Template" if not provided.

team_members
object[]

Team members to assign to this job with their roles. Each entry must have at least one of team_member_id or team_member_email, and at least one of role_id or role_name.

job_description
string

Plain-text job description.

location
string

Job location (e.g. "San Francisco, CA")

primary_url
string<uri>

Primary URL for the job posting (e.g. company careers page).

currency_code
string

ISO 4217 currency code for salary and fee values (e.g. "USD", "EUR", "GBP")

Pattern: ^[A-Z]{3}$
job_function
string

Job function or department (e.g. "Engineering", "Marketing", "Finance")

open_date
string

Date the job opens for candidates (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string

Target close date for the job (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
salary_min
integer

Minimum annual salary in the smallest currency unit (e.g. 80000 for $80,000)

Required range: x >= 0
salary_max
integer

Maximum annual salary in the smallest currency unit (e.g. 120000 for $120,000)

Required range: x >= 0
fee
number

Placement fee amount for this job

Required range: x >= 0
firm_commission_percent
number

Percentage of the placement fee that goes to the firm (0-100).

Required range: 0 <= x <= 100

Response

Job created

success
enum<boolean>
required
Available options:
true
data
object
required