Skip to content
Atlast Atlast Atlast Developer Docs

Getting started

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

  1. Create an API key

    Section titled “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

    Section titled “Make your first request”

    List your organisation’s published jobs:

    Terminal window
    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": "Barcelona, Spain (Hybrid) · Spain (Remote)",
          "locations": [
            {
              "id": "jlc-550e8400-e29b-41d4-a716-446655440000",
              "countryCode": "ES",
              "countryName": "Spain",
              "cityId": 3128760,
              "cityName": "Barcelona",
              "workArrangement": "HYBRID",
              "sortOrder": 0
            },
            {
              "id": "jlc-6fa459ea-ee8a-3ca4-894e-db77e160355e",
              "countryCode": "ES",
              "countryName": "Spain",
              "cityId": null,
              "cityName": null,
              "workArrangement": "REMOTE",
              "sortOrder": 1
            }
          ],
          "department": "Engineering",
          "type": "Full-time",
          "seniorityLevel": "Senior",
          "minSalary": 80000,
          "maxSalary": 120000,
          "currency": "USD",
          "compensationType": "PAID",
          "compensationNote": null,
          "jobUrl": "https://acme.careers.atlasthq.com/jobs/abc123def456",
          "applyUrl": "https://acme.careers.atlasthq.com/jobs/abc123def456/apply"
        }
      ],
      "page": 1,
      "pageSize": 20,
      "total": 1
    }

    A job can be open in several places. locations lists each one with its ISO country code, its city (null for a country-wide location) and its work arrangement (ON_SITE, HYBRID or REMOTE). location is a one-line summary of that list built by Atlast, or null when the job has no locations — read locations if you need structured data.

  3. Fetch a single job

    Section titled “Fetch a single job”

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

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

  4. Switch to webhooks to stay in sync

    Section titled “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

Section titled “Pagination”

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

Terminal window
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.