API

Documentation

Version 1.0

Jobs API

The Jobs API allows you to programmatically access and manage job listings on the AutoTechJobs platform.

GET

/jobs

Retrieve a list of job listings with optional filtering, sorting, and pagination.

Query Parameters

ParameterTypeDescription
pageintegerPage number for pagination (default: 1)
limitintegerNumber of results per page (default: 20, max: 100)
searchstringSearch term to filter jobs by title, description, or company
locationstringFilter jobs by location
categorystringFilter jobs by category
salary_minintegerFilter jobs by minimum salary
sortstringSort results by: date_posted, salary, relevance (default: date_posted)
orderstringSort order: asc or desc (default: desc)

Example Request

curl -X GET   "https://api.autotechjobs.co.uk/v1/jobs?page=1&limit=10&category=software-engineering&sort=date_posted"   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"

Example Response

{
  "data": [
    {
      "id": "job_123456",
      "title": "Senior React Developer",
      "company": "Tech Innovations Ltd",
      "location": "London, UK",
      "description": "We are looking for a Senior React Developer to join our team...",
      "salary": {
        "min": 60000,
        "max": 80000,
        "currency": "GBP",
        "period": "year"
      },
      "category": "software-engineering",
      "type": "full-time",
      "remote": true,
      "posted_at": "2025-04-01T10:00:00Z",
      "expires_at": "2025-05-01T10:00:00Z",
      "is_featured": true,
      "application_url": "https://api.autotechjobs.co.uk/v1/jobs/job_123456/apply",
      "company_logo_url": "https://example.com/logos/tech-innovations.png"
    },
    // More job listings...
  ],
  "meta": {
    "pagination": {
      "total": 42,
      "pages": 5,
      "page": 1,
      "limit": 10
    }
  }
}
GET

/jobs/:id

Retrieve detailed information about a specific job listing.

Path Parameters

ParameterTypeDescription
idstringUnique identifier of the job

Example Request

curl -X GET   "https://api.autotechjobs.co.uk/v1/jobs/job_123456"   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"

Example Response

{
  "data": {
    "id": "job_123456",
    "title": "Senior React Developer",
    "company": "Tech Innovations Ltd",
    "location": "London, UK",
    "description": "We are looking for a Senior React Developer to join our team...",
    "requirements": [
      "5+ years of experience with React",
      "Strong TypeScript skills",
      "Experience with state management libraries"
    ],
    "benefits": [
      "Competitive salary",
      "Remote work options",
      "Professional development budget"
    ],
    "salary": {
      "min": 60000,
      "max": 80000,
      "currency": "GBP",
      "period": "year"
    },
    "category": "software-engineering",
    "type": "full-time",
    "remote": true,
    "posted_at": "2025-04-01T10:00:00Z",
    "expires_at": "2025-05-01T10:00:00Z",
    "is_featured": true,
    "is_urgent": false,
    "is_highlighted": true,
    "application_url": "https://api.autotechjobs.co.uk/v1/jobs/job_123456/apply",
    "company_logo_url": "https://example.com/logos/tech-innovations.png",
    "company_website": "https://techinnovations.example.com",
    "contact_email": "[email protected]"
  }
}
POST

/jobs

Create a new job listing. This endpoint is only available to employer accounts.

Request Body

FieldTypeRequiredDescription
titlestringYesJob title
descriptionstringYesDetailed job description
locationstringYesJob location
categorystringYesJob category
typestringYesJob type (full-time, part-time, contract, etc.)
salaryobjectNoSalary information (min, max, currency, period)
requirementsarrayNoList of job requirements
benefitsarrayNoList of job benefits
remotebooleanNoWhether the job is remote (default: false)
expires_atstringNoISO 8601 date when the job listing expires

Example Request

curl -X POST   "https://api.autotechjobs.co.uk/v1/jobs"   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{
    "title": "Senior React Developer",
    "description": "We are looking for a Senior React Developer to join our team...",
    "location": "London, UK",
    "category": "software-engineering",
    "type": "full-time",
    "salary": {
      "min": 60000,
      "max": 80000,
      "currency": "GBP",
      "period": "year"
    },
    "requirements": [
      "5+ years of experience with React",
      "Strong TypeScript skills",
      "Experience with state management libraries"
    ],
    "benefits": [
      "Competitive salary",
      "Remote work options",
      "Professional development budget"
    ],
    "remote": true,
    "expires_at": "2025-05-01T10:00:00Z"
  }'

Example Response

{
  "data": {
    "id": "job_123456",
    "title": "Senior React Developer",
    "company": "Tech Innovations Ltd",
    "location": "London, UK",
    "description": "We are looking for a Senior React Developer to join our team...",
    "requirements": [
      "5+ years of experience with React",
      "Strong TypeScript skills",
      "Experience with state management libraries"
    ],
    "benefits": [
      "Competitive salary",
      "Remote work options",
      "Professional development budget"
    ],
    "salary": {
      "min": 60000,
      "max": 80000,
      "currency": "GBP",
      "period": "year"
    },
    "category": "software-engineering",
    "type": "full-time",
    "remote": true,
    "posted_at": "2025-04-10T20:32:13Z",
    "expires_at": "2025-05-01T10:00:00Z",
    "is_featured": false,
    "is_urgent": false,
    "is_highlighted": false,
    "is_active": false,
    "application_url": "https://api.autotechjobs.co.uk/v1/jobs/job_123456/apply"
  }
}

Note: New jobs are created with is_active: false by default. To activate a job, you need to make a payment using the Employers API.

Additional Endpoints

The Jobs API also includes the following endpoints:

  • PUT /jobs/:id - Update an existing job listing
  • DELETE /jobs/:id - Delete a job listing
  • POST /jobs/:id/activate - Activate a job listing (requires payment)
  • GET /jobs/categories - List all job categories
  • GET /jobs/types - List all job types