API Documentation

    Integrate HubNugget job listings into your platform with our RESTful API. Get access to active job listings with advanced filtering, pagination, and real-time updates.

    Getting Started

    1. Get Your API Key

    Sign up for a HubNugget account and generate your API key from the dashboard. API keys are free during beta.

    Get API Key

    2. Base URL

    All API requests should be made to:

    https://api.hubnugget.com/public/jobs

    3. Authentication

    Include your API key in the x-api-key header:

    x-api-key: API-019a7e8f-115a-735c-9b05-ba929823b5d5-HN-2025-11-14
    GET

    Get Active Jobs

    https://api.hubnugget.com/public/jobs

    Description

    Retrieve a paginated list of active job listings. Supports advanced filtering, sorting, and search capabilities.

    Query Parameters

    ParameterTypeRequiredDescription
    limitinteger
    Optional
    Number of items per page (default: 10)
    pageinteger
    Optional
    Page number (default: 1)
    sortOrderstring
    Optional
    Sort order: ASC or DESC (default: DESC)

    Code Examples

    curl -X 'GET' \
      'https://api.hubnugget.com/public/jobs?limit=10&page=1&sortOrder=DESC' \
      -H 'accept: */*' \
      -H 'x-api-key: API-019a7e8f-115a-735c-9b05-ba929823b5d5-HN-2025-11-14'

    Response

    {
      "success": true,
      "statusCode": 200,
      "path": "/public/jobs?limit=10&page=1&sortOrder=DESC",
      "timeStamp": "Thu, 13 Nov 2025 18:56:41 GMT",
      "payload": {
        "data": [
          {
            "id": "120",
            "createOn": "2025-11-03T14:26:57.761Z",
            "updatedOn": "2025-11-11T01:00:00.051Z",
            "deletedAt": null,
            "status": "INACTIVE",
            "title": "software developer",
            "description": "This is testing",
            "primarySkills": [
              "ANGULAR",
              "NODEJS",
              "NESTJS",
              "POSTGRES",
              "MONGODB",
              "MYSQL"
            ],
            "secondarySkills": [
              "AWS",
              "DIGITAL OCEAN"
            ],
            "jobType": "full_time",
            "jobMode": "onsite",
            "location": [
              "CHENNAI",
              "MUMBAI",
              "PUNA",
              "HYDRABAD"
            ],
            "perks": [
              "REMOTE",
              "HEALTH INSURANCE",
              "YEARLY INCREAMENT"
            ],
            "preferredLanguages": [
              "HINDI",
              "ENGLISH"
            ],
            "minExperience": 0,
            "maxExperience": 5,
            "fromSalary": 50000,
            "toSalary": 100000,
            "fixedSalary": null,
            "compensationCurrency": "INR",
            "isVisaSponsorshipAvailable": false,
            "isOurPlatform": true,
            "applicationLink": null,
            "expiresOn": "2025-11-10T18:30:00.000Z",
            "interviewRoundTemplate": {
              "id": "59",
              "title": "junior developer",
              "totalNumberOfRounds": 3,
              "roundsType": [
                1,
                2,
                3
              ],
              "roundsTypeTimer": [
                15,
                15,
                15
              ]
            },
            "applicantCount": []
          }
        ],
        "total": 7,
        "page": 1,
        "limit": 10
      }
    }

    Empty Result (No Jobs Found)

    {
      "success": true,
      "statusCode": 200,
      "message": "OK",
      "path": "/public/jobs?limit=10&page=1",
      "timeStamp": "Thu, 14 Nov 2025 00:00:00 GMT",
      "payload": {
        "data": [],
        "total": 0,
        "page": 1,
        "limit": 10
      }
    }

    Response Schema

    success (boolean) - Request success status
    statusCode (integer) - HTTP status code
    path (string) - API endpoint path with query parameters
    timeStamp (string) - Response timestamp
    payload (object) - Response payload containing data and pagination
    payload.data (array) - Array of job objects
    payload.total (integer) - Total number of jobs
    payload.page (integer) - Current page number
    payload.limit (integer) - Items per page

    Error Responses

    401 Unauthorized - Missing API Key

    When x-api-key header is missing or empty

    {
      "success": false,
      "statusCode": 401,
      "timestamp": "Thu, 14 Nov 2025 00:00:00 GMT",
      "path": "/public/jobs?limit=10&page=1",
      "message": "API key is required",
      "payload": []
    }
    401 Unauthorized - Invalid API Key

    When API key does not exist, format is incorrect, or belongs to a non-existent account

    {
      "success": false,
      "statusCode": 401,
      "timestamp": "Thu, 14 Nov 2025 00:00:00 GMT",
      "path": "/public/jobs?limit=10&page=1",
      "message": "Invalid API key",
      "payload": []
    }
    401 Unauthorized - Account Not Verified

    When API key exists but the associated account is not verified

    {
      "success": false,
      "statusCode": 401,
      "timestamp": "Thu, 14 Nov 2025 00:00:00 GMT",
      "path": "/public/jobs?limit=10&page=1",
      "message": "Invalid API key",
      "payload": []
    }

    Rate Limits

    Free Tier (Beta)

    • 100 requests per minute
    • 10,000 requests per day
    • Rate limit headers included in responses

    Rate Limit Headers:

    • X-RateLimit-Limit - Request limit per window
    • X-RateLimit-Remaining - Remaining requests
    • X-RateLimit-Reset - Time when limit resets

    Support & Resources

    Need Help?

    Contact our developer support team for assistance with API integration.

    Contact Support

    Status Page

    Check API status and uptime information.

    View Status