Job

A saved job's full content, as returned by POST /api/v1/jobs, GET /api/v1/jobs/{jobId}, and PATCH /api/v1/jobs/{jobId}.

idstringrequired

The platform-assigned job id (UUID). Usable as job_id on CV DeepMatch and CV DeepSearch run submits.

Example: 6f0d5c2e-1b7a-4c3d-9e8f-2a1b3c4d5e6f

client_idstringrequired

The owning client.

position_idstringnullablerequired

Your own job identifier (null when the job has none). Usable as position_id on run submits.

Example: eng-backend-2026

namestringrequired

Display name.

job_descriptionstringrequired

The JD prose.

config objectrequired

The job's structured requirements config — the same position-config contract CV DeepMatch validates at submit: it must carry requirements.workExperience and requirements.skills, and every inner field must pass the per-field rules (the 1–5 importance scale, industry cardinality, language-config quirks — see the CvDeepMatchRequirements schema and the Position config reference).

Unlike an inline run submit, the contract is enforced at save time — an invalid config is rejected with per-field errors and nothing is stored. config must not contain a top-level job_description key (the JD is its own field; CV DeepSearch composes position_metadata as {...config, job_description}).

property name*any

The job's structured requirements config — the same position-config contract CV DeepMatch validates at submit: it must carry requirements.workExperience and requirements.skills, and every inner field must pass the per-field rules (the 1–5 importance scale, industry cardinality, language-config quirks — see the CvDeepMatchRequirements schema and the Position config reference).

Unlike an inline run submit, the contract is enforced at save time — an invalid config is rejected with per-field errors and nothing is stored. config must not contain a top-level job_description key (the JD is its own field; CV DeepSearch composes position_metadata as {...config, job_description}).

Example: {"name":"Senior Backend Engineer","requirements":{"workExperience":{"from":5,"to":10,"importance":5,"relevant_industries":["SaaS","Fintech"],"industries_config":[{"name":"SaaS","importance":5},{"name":"Fintech","importance":4}]},"skills":{"importance":5,"skills_config":{"hard_skills":[{"name":"Node.js","importance":5}],"requirements":{"minimal_qualifications":true,"preferable_qualifications":true}}}}}

created_atdate-timerequired

updated_atdate-timerequired

Bumped on every update — including a saveJob upsert from a run submit. Drives CV DeepSearch's automatic plan-rebuild detection.

Job

{
  "id": "6f0d5c2e-1b7a-4c3d-9e8f-2a1b3c4d5e6f",
  "client_id": "string",
  "position_id": "eng-backend-2026",
  "name": "string",
  "job_description": "string",
  "config": {
    "name": "Senior Backend Engineer",
    "requirements": {
      "workExperience": {
        "from": 5,
        "to": 10,
        "importance": 5,
        "relevant_industries": [
          "SaaS",
          "Fintech"
        ],
        "industries_config": [
          {
            "name": "SaaS",
            "importance": 5
          },
          {
            "name": "Fintech",
            "importance": 4
          }
        ]
      },
      "skills": {
        "importance": 5,
        "skills_config": {
          "hard_skills": [
            {
              "name": "Node.js",
              "importance": 5
            }
          ],
          "requirements": {
            "minimal_qualifications": true,
            "preferable_qualifications": true
          }
        }
      }
    }
  },
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}