{
 "openapi": "3.1.0",
 "info": {
  "title": "Contingent Candidates (Talent & Contingent Workforce)",
  "version": "20261030b",
  "description": "The database, which in a staffing business is the asset. Right to work and its expiry are columns rather than notes, because a contractor whose permission runs out mid-assignment is the most expensive mistake in this module."
 },
 "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
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "location_id": {
      "type": "string",
      "format": "uuid",
      "description": "Office"
     },
     "candidate_no": {
      "type": "string",
      "description": "Candidate no",
      "readOnly": true
     },
     "first_name": {
      "type": "string",
      "description": "First name"
     },
     "last_name": {
      "type": "string",
      "description": "Last name"
     },
     "preferred_name": {
      "type": "string",
      "description": "Preferred name"
     },
     "name_local": {
      "type": "string",
      "description": "Local name"
     },
     "email": {
      "type": "string",
      "description": "Email"
     },
     "phone": {
      "type": "string",
      "description": "Phone"
     },
     "mobile": {
      "type": "string",
      "description": "Mobile"
     },
     "address": {
      "type": "string",
      "description": "Address"
     },
     "city": {
      "type": "string",
      "description": "City"
     },
     "state": {
      "type": "string",
      "description": "State or province"
     },
     "country": {
      "type": "string",
      "description": "Country"
     },
     "postal_code": {
      "type": "string",
      "description": "Postal code"
     },
     "current_title": {
      "type": "string",
      "description": "Current title"
     },
     "current_employer": {
      "type": "string",
      "description": "Current employer"
     },
     "total_experience_years": {
      "type": "string",
      "format": "decimal",
      "description": "Experience (years)"
     },
     "education_level": {
      "type": "string",
      "description": "Education"
     },
     "linkedin_url": {
      "type": "string",
      "description": "LinkedIn"
     },
     "source": {
      "type": "string",
      "description": "Source"
     },
     "source_detail": {
      "type": "string",
      "description": "Source detail"
     },
     "referred_by": {
      "type": "string",
      "description": "Referred by"
     },
     "owner_recruiter_id": {
      "type": "string",
      "format": "uuid",
      "description": "Owning recruiter"
     },
     "work_authorization": {
      "type": "string",
      "description": "Right to work"
     },
     "work_auth_expires_on": {
      "type": "string",
      "format": "date",
      "description": "Right to work expires"
     },
     "employment_preference": {
      "type": "string",
      "description": "Prefers to work as"
     },
     "supplier_id": {
      "type": "string",
      "format": "uuid",
      "description": "Through supplier"
     },
     "willing_to_relocate": {
      "type": "boolean",
      "description": "Will relocate"
     },
     "willing_remote": {
      "type": "boolean",
      "description": "Will work remotely"
     },
     "availability_date": {
      "type": "string",
      "format": "date",
      "description": "Available from"
     },
     "notice_period_days": {
      "type": "integer",
      "description": "Notice period (days)"
     },
     "currency": {
      "type": "string",
      "description": "Currency"
     },
     "rate_unit": {
      "type": "string",
      "description": "Rate unit",
      "enum": [
       "hour",
       "day",
       "week",
       "month",
       "year",
       "fixed"
      ]
     },
     "desired_pay_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Wants (rate)"
     },
     "desired_salary": {
      "type": "string",
      "format": "decimal",
      "description": "Wants (salary)"
     },
     "status": {
      "type": "string",
      "description": "Status"
     },
     "rating": {
      "type": "integer",
      "description": "Rating"
     },
     "resume_summary": {
      "type": "string",
      "description": "Summary"
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "employee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Employee record"
     },
     "student_id": {
      "type": "string",
      "format": "uuid",
      "description": "Student record"
     },
     "user_id": {
      "type": "string",
      "format": "uuid",
      "description": "Portal sign-in"
     },
     "consent_given_on": {
      "type": "string",
      "format": "date",
      "description": "Consent given"
     },
     "consent_source": {
      "type": "string",
      "description": "Consent source"
     },
     "do_not_contact": {
      "type": "boolean",
      "description": "Do not contact"
     },
     "last_contacted_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last contacted at",
      "readOnly": true
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "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
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/ats/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/ats/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/ats/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"
     }
    }
   }
  },
  "/api/ats/candidates/{parentId}/skills": {
   "get": {
    "summary": "Skills",
    "operationId": "action_candidates_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Skills",
    "operationId": "action_candidates_1_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/candidates/{parentId}/skills/{lineId}": {
   "put": {
    "summary": "Skills",
    "operationId": "action_candidates_0_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Skills",
    "operationId": "action_candidates_1_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/candidates/{parentId}/employment": {
   "get": {
    "summary": "Employment",
    "operationId": "action_candidates_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Employment",
    "operationId": "action_candidates_1_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/candidates/{parentId}/employment/{lineId}": {
   "put": {
    "summary": "Employment",
    "operationId": "action_candidates_0_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Employment",
    "operationId": "action_candidates_1_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/candidates/{parentId}/documents": {
   "get": {
    "summary": "Documents",
    "operationId": "action_candidates_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Documents",
    "operationId": "action_candidates_1_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/candidates/{parentId}/documents/{lineId}": {
   "put": {
    "summary": "Documents",
    "operationId": "action_candidates_0_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Documents",
    "operationId": "action_candidates_1_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/candidates/{id}/summarise": {
   "post": {
    "summary": "Summarise",
    "operationId": "action_candidates_0_6",
    "description": "Body keys: jobOrderId, resumeText",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/candidates/{id}/preview": {
   "get": {
    "summary": "Preview",
    "operationId": "action_candidates_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/candidates/from-student/{id}": {
   "post": {
    "summary": "From student",
    "operationId": "action_candidates_0_6",
    "description": "Body keys: recruiterId",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}