Job

This documentation describes the Job data model for developers who will integrate with the job search API. The model contains various properties that represent detailed aspects of job listings. Each property is essential for creating comprehensive job records.

Model Properties

  • createdAt (Date): The date and time when the job listing was created. Defaults to the time of record creation.

  • websiteName (String): The name of the website where the job is listed.

  • websiteUrl (String): The full URL to the website's homepage.

  • url (String): The direct URL to the specific job listing. This field is unique for each job.

  • domain (String): The internet domain associated with the website listing the job.

  • status (String): The current status of the job listing, such as "open", "closed", or "expired".

  • description (String): A text description of the job listing, detailing responsibilities and other relevant information.

  • employmentType (String): The type of employment (e.g., full-time, part-time, contract).

  • published_since (Date): The date the job was originally posted.

  • published_until (Date): The expiration date of the job listing.

  • image (String): URL to an image relevant to the job, if available.

  • responsibilities (String): Description of job responsibilities.

  • workHours (String): Typical work hours for the position (e.g., "9-5", "flexible").

  • skills (String): Required skills for the job.

  • occupationalCategory (String): The occupational category or industry segment that the job falls under.

  • industry (String): The industry associated with the job.

  • experienceRequirements (String): General description of experience required.

  • experienceRequirementsType (String): The type of experience required (e.g., "years", "projects").

  • experienceRequirementsMonthsOfExperience (Number): Specific number of months of experience required.

  • qualifications (String): Qualifications required for the job.

  • educationRequirements (String): Educational background required for the job.

  • title (String): The title of the job.

  • directApply (String): Indicates whether it is possible to apply directly through the provided URL.

  • baseSalary:

    • Type (String): Type of salary (e.g., "annual", "hourly").

    • Currency (String): Currency of the salary (e.g., USD, EUR).

    • ValueType (String): Nature of the salary amount (e.g., "range", "fixed").

    • MaxValue (Number): The maximum salary offered.

    • MinValue (Number): The minimum salary offered.

    • UnitText (String): The unit of salary payment (e.g., per hour, per year).

  • estimatedSalary (similar structure to baseSalary): An estimation of the salary if actual values are not provided.

  • hiringOrganization:

    • Type (String): The type of the hiring organization (e.g., "Company", "NGO").

    • Logo (String): URL to the organization's logo.

    • Url (String): Website URL of the hiring organization.

    • Name (String): Name of the hiring organization.

    • Email (String): Contact email of the hiring organization.

    • Phone (String): Phone number of the hiring organization.

    • Telephone (String): Alternate telephone number of the hiring organization.

  • identifier:

    • Type (String): Type of identifier used (e.g., "internal", "external").

    • Value (String): The value of the identifier.

    • Name (String): A name associated with the identifier (e.g., job ID).

  • applicantLocationRequirements:

    • Type (String): The type of location requirement (e.g., "specific", "anywhere").

    • Name (String): The name of the location where the applicant must be based.

  • location:

    • Type (String): Type of location (e.g., "office", "remote").

    • Name (String): The name of the location.

    • Address:

      • Type (String): Type of address (e.g., "physical", "mailing").

      • Country (String): Country of the job location

Last updated