Getting started

This guide gets you from zero to your first successful API call.

1. Create an API key

   In the Atlast Portal, go to Settings → Integrations → API keys and create a key. The key is shown once — copy it somewhere safe. If you lose it, revoke it and create a new one.

   See Authentication for how keys work.

2. Make your first request

   List your organisation’s published jobs:

   curl https://api.atlasthq.com/api/public/v1/jobs \
     -H "Authorization: Bearer atlk_live_8f3c2a1b9d4e5f60a7b8c9d0e1f2a3b4"

   You’ll get back a paginated list of job summaries:

   {
     "data": [
       {
         "id": "job-550e8400-e29b-41d4-a716-446655440000",
         "publicId": "abc123def456",
         "jobTitle": "Senior Software Engineer",
         "location": "San Francisco, CA",
         "department": "Engineering",
         "type": "Full-time",
         "seniorityLevel": "Senior",
         "minSalary": 80000,
         "maxSalary": 120000,
         "currency": "USD",
         "jobUrl": "https://acme.careers.atlasthq.com/jobs/abc123def456",
         "applyUrl": "https://acme.careers.atlasthq.com/jobs/abc123def456/apply"
       }
     ],
     "page": 1,
     "pageSize": 20,
     "total": 1
   }

3. Fetch a single job

   Use the publicId from the list to fetch a job’s full detail:

   curl https://api.atlasthq.com/api/public/v1/jobs/abc123def456 \
     -H "Authorization: Bearer atlk_live_8f3c2a1b9d4e5f60a7b8c9d0e1f2a3b4"

4. Switch to webhooks to stay in sync

   The steps above are how you backfill. To stay current, don’t poll — configure a webhook so Atlast pushes an event whenever a job changes, then re-fetch that job. This webhook-then-re-fetch loop is the recommended way to integrate.

Pagination

The list endpoint accepts page (default 1) and pageSize (default 20, max 100):

curl "https://api.atlasthq.com/api/public/v1/jobs?page=2&pageSize=50" \
  -H "Authorization: Bearer atlk_live_8f3c2a1b9d4e5f60a7b8c9d0e1f2a3b4"

Read the full contract in the Jobs API reference.