{
 "openapi": "3.1.0",
 "info": {
  "title": "Candidates (HRMS)",
  "version": "20261030b",
  "description": "Everybody who has been in front of this company for a post, whether they applied or were found. Somebody already employed here is marked internal, which is what makes an internal move visible as one."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "candidates": {
    "type": "object",
    "required": [
     "first_name",
     "last_name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "candidate_no": {
      "type": "string",
      "description": "Candidate no",
      "readOnly": true
     },
     "first_name": {
      "type": "string",
      "description": "First name"
     },
     "last_name": {
      "type": "string",
      "description": "Last name"
     },
     "email": {
      "type": "string",
      "description": "Email"
     },
     "phone": {
      "type": "string",
      "description": "Phone"
     },
     "city": {
      "type": "string",
      "description": "City"
     },
     "country": {
      "type": "string",
      "description": "Country"
     },
     "linkedin_url": {
      "type": "string",
      "description": "Linkedin url"
     },
     "current_employer": {
      "type": "string",
      "description": "Current employer"
     },
     "current_title": {
      "type": "string",
      "description": "Current title"
     },
     "years_experience": {
      "type": "string",
      "format": "decimal",
      "description": "Years of experience"
     },
     "is_internal": {
      "type": "boolean",
      "description": "Already works here"
     },
     "employee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Employee record"
     },
     "source": {
      "type": "string",
      "description": "How they came to us"
     },
     "referred_by_id": {
      "type": "string",
      "format": "uuid",
      "description": "Referred by id"
     },
     "consent_given_on": {
      "type": "string",
      "format": "date",
      "description": "Consent given on",
      "readOnly": true
     },
     "consent_expires_on": {
      "type": "string",
      "format": "date",
      "description": "Consent expires on",
      "readOnly": true
     },
     "delete_after": {
      "type": "string",
      "format": "date",
      "description": "Delete after",
      "readOnly": true
     },
     "talent_pool": {
      "type": "string",
      "description": "Talent pool"
     },
     "rating": {
      "type": "integer",
      "description": "Rating"
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "email_opt_out": {
      "type": "boolean",
      "description": "Email opt out",
      "readOnly": true
     },
     "sms_opt_out": {
      "type": "boolean",
      "description": "Sms opt out",
      "readOnly": true
     },
     "opted_out_at": {
      "type": "string",
      "format": "date-time",
      "description": "Opted out at",
      "readOnly": true
     },
     "opt_out_reason": {
      "type": "string",
      "description": "Opt out reason",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/candidates": {
   "get": {
    "summary": "list candidates",
    "operationId": "list_candidates_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create candidates",
    "operationId": "create_candidates_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/candidates/{id}": {
   "get": {
    "summary": "get candidates",
    "operationId": "get_candidates_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change candidates",
    "operationId": "change_candidates_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete candidates",
    "operationId": "delete_candidates_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/candidates/{id}/message": {
   "post": {
    "summary": "Message",
    "operationId": "action_candidates_0_6",
    "description": "Body keys: templateId, body, applicationId, subject, channel",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/candidates/{id}/opt-out": {
   "post": {
    "summary": "Opt out",
    "operationId": "action_candidates_0_6",
    "description": "Body keys: email, sms, reason",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/candidates/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_candidates_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}