Skip to main content

5-Minute Quickstart

Get started with the XeCubes Developer API in minutes. In this tutorial, you will:

  1. Retrieve your API Secret Key from the Recruiter Dashboard.
  2. Authenticate your first request to verify tenant access.
  3. List active jobs in your organization.

Step 1: Obtain Your API Key​

  1. Navigate to the XeCubes Recruiter Dashboard.
  2. Go to Settings → API & Integrations.
  3. Under Developer Keys, click Create API Key.
  4. Copy your secret key (xh_live_...). Store it securely; you will not be able to view it again.

⚠️ Important: Never commit your secret keys to public repositories or client-side frontends. Always proxy requests through your backend services.


Step 2: Verify Connection (/recruiter/bootstrap)​

Send a GET request to /recruiter/bootstrap to verify that your key is active and return your workspace context:

curl -X GET "https://api.xecubes.com/recruiter/bootstrap" \
-H "X-API-Key: xh_live_your_secret_key"

Expected Response​

{
"status": "success",
"data": {
"org": {
"id": "org_92A838HDK8",
"name": "Acme Talent Corp",
"status": "active"
},
"profile": {
"id": "usr_78H234J8K",
"email": "[email protected]",
"role": "owner"
}
}
}

Step 3: Fetch Active Jobs​

Now let's query the jobs configured in your organization:

curl -X GET "https://api.xecubes.com/recruiter/jobs" \
-H "X-API-Key: xh_live_your_secret_key"

Sample Response​

{
"status": "success",
"data": [
{
"id": "job_37H283J8K",
"title": "Senior Staff AI Architect",
"company_name": "Acme Talent Corp",
"location": "San Francisco, CA (Hybrid)",
"status": "active",
"openings": 2,
"created_at": "2026-06-05T12:00:00Z"
}
]
}

Next Steps​

  • Explore the Resume Parser API to parse PDF resumes into structured candidate records.
  • Configure Event Webhooks for instant notifications when candidates complete AI interviews.
  • Check our API Rate Limits to plan your concurrency and throttling.