{ "openapi": "3.1.0", "info": { "title": "Careerflow Organization API", "version": "2.0.0", "description": "## Introduction\n\nThe Careerflow Organization API lets partner institutions integrate with the Careerflow platform programmatically. Use it to manage students, coaches, groups, resumes, job tracking, AI-powered career tools, and reporting — all scoped to your organization.\n\nThis API is intended for **server-to-server** use by institute owners, admins, and technical partners.\n\n---\n\n## Getting Started\n\n### 1. Obtain an API Key\n\nOrganization **Owners** and **Admins** can create API keys from the Careerflow coaching portal.\n\n**Step 1.** Go to **Settings → Developer Settings → API Keys**.\n\n![API Keys page](./assets/step1-api-keys-page.png)\n\n**Step 2.** Click **+ Create Key**, optionally give it a name, and click **Create**.\n\n![Create API Key modal](./assets/step2-create-key.png)\n\n**Step 3.** Copy the secret immediately — it is shown **only once** and cannot be retrieved later.\n\n![Copy secret key](./assets/step3-copy-secret.png)\n\nYou can create up to **3 active keys** per organization. Keys expire after **1 year** by default.\n\nTo revoke a key, click **Revoke** on the API Keys page. Revocation takes effect immediately.\n\n### 2. Authenticate Requests\n\nPass your API key in the `cf_api_key` header on every request:\n\n```\ncf_api_key: YOUR_API_KEY\n```\n\nRequests without a valid key, or with an expired/revoked key, receive a `403 Forbidden` response.\n\n---\n\n## Environments\n\n| Environment | Base URL | Notes |\n|---|---|---|\n| **Production** | `https://api.careerflow.ai` | Live data |\n| **Development** | `https://api-dev.careerflow.ai` | Sandbox — safe for development |\n\nSome endpoints (e.g. Data Endpoints / BigQuery) are available in production only.\n\n---\n\n## Path Structure\n\nEndpoints are prefixed by the service they belong to:\n\n- `/instituteApp/v2/...` — Organization management, webhooks, reporting\n- `/jobTracker/v2/...` — Job boards, resumes, documents, contacts, goals\n- `/aiTools/v2/...` — AI generation (cover letters, pitches, LinkedIn)\n- `/ai-services/v1/...` — Resume optimization and prompt generation\n- `/stats/v1/...` — BigQuery analytics\n\nThe server URL points to the API root. Use the full path as shown in each endpoint.\n\n---\n\n\n> **Note:** In the API, \"Student\" refers to what is called a \"Job Seeker\" in the Careerflow product interface. These terms are interchangeable — both refer to end users of the platform who are seeking employment.\n\n---\n\n## Errors\n\nAll error responses return JSON with a `message` field:\n\n```json\n{\n \"message\": \"A human-readable error description\"\n}\n```\n\nSome errors also include a `code` field for programmatic handling.\n\n### Standard Status Codes\n\n| Code | Meaning |\n|---|---|\n| `200` | Success |\n| `201` | Created |\n| `400` | Bad Request — invalid or missing parameters |\n| `401` | Unauthorized — missing or invalid authentication |\n| `403` | Forbidden — valid auth but insufficient permissions, or invalid/expired API key |\n| `404` | Not Found — resource does not exist |\n| `409` | Conflict — resource already exists |\n| `429` | Too Many Requests — rate limit exceeded |\n| `500` | Internal Server Error |\n\n---\n\n## Pagination\n\nList endpoints that accept a request body typically support pagination via `page` and `size` parameters. Check individual endpoint descriptions for supported pagination fields.\n\n---\n\n## Versioning\n\nCurrent API version is **v2** (paths prefixed with `/v2/`). A small number of endpoints still use `/v1/`. Both versions are stable and supported.\n\n---\n\n## MCP Server (AI Assistant Integration)\n\nCareerflow exposes an [MCP (Model Context Protocol)](https://modelcontextprotocol.io) server that lets AI assistants like **Claude**, **Cursor**, and **GitHub Copilot** discover and call Careerflow APIs as tools.\n\n### Endpoint\n\n| | URL |\n|---|---|\n| **MCP Server** | `https://api.careerflow.ai/instituteApp/v2/mcp` |\n| **AI Agent Skill File** | [`skill.md`](./skill.md) — drop into your AI editor config so the agent knows when and how to use Careerflow |\n\n### Setup\n\nPass your API key via the `cf-api-key` header in your MCP client configuration.\n\n**Claude Desktop** — add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\\Claude\\claude_desktop_config.json` (Windows):\n\n```json\n{\n \"mcpServers\": {\n \"careerflow-admin\": {\n \"url\": \"https://api.careerflow.ai/instituteApp/v2/mcp\",\n \"headers\": {\n \"cf-api-key\": \"YOUR_API_KEY\"\n }\n }\n }\n}\n```\n\n**Claude Code** (CLI):\n\n```bash\nclaude mcp add careerflow-admin --transport http --header \\\"cf-api-key: YOUR_API_KEY\\\" https://api.careerflow.ai/instituteApp/v2/mcp\n```\n\n**Cursor** — add to `.cursor/mcp.json` in your project:\n\n```json\n{\n \"mcpServers\": {\n \"careerflow-admin\": {\n \"url\": \"https://api.careerflow.ai/instituteApp/v2/mcp\",\n \"headers\": {\n \"cf-api-key\": \"YOUR_API_KEY\"\n }\n }\n }\n}\n```\n\nOnce configured, the AI assistant will automatically discover all 74 available tools covering student management, resume building, job tracking, AI tools, reporting, and more.\n\nFor a complete guide with usage patterns, download the [skill.md](./skill.md) file and add it to your project's AI agent configuration." }, "servers": [ { "url": "https://api.careerflow.ai", "description": "Production" }, { "url": "https://api-dev.careerflow.ai", "description": "Development" } ], "security": [ { "cf_api_key": [] } ], "tags": [ { "name": "Organization Administration", "description": "Manage students, coaches, groups, resources, goals, checklists, and other organizational settings." }, { "name": "Job Seeker Management", "description": "Access job seeker documents, contacts, and job tracker boards." }, { "name": "Resume Builder", "description": "Create, update, optimize, clone, download, and delete resumes." }, { "name": "Job Tracker", "description": "Manage job cards, linked contacts, linked documents, activities, and tasks." }, { "name": "AI Tools", "description": "Generate AI-powered content: cover letters, elevator pitches, LinkedIn headlines and about sections." }, { "name": "Webhooks", "description": "Configure and manage webhook subscriptions and view webhook event activity." }, { "name": "Data Endpoints", "description": "Query aggregated analytics data from BigQuery. Only available in production." }, { "name": "SCIM", "description": "SCIM event processing for identity provider integrations (ScaleKit)." }, { "name": "Audit Logs", "description": "Retrieve audit log entries by institute, user, or creator." }, { "name": "Application Logs", "description": "View application-level logs and drill down by span ID." }, { "name": "Reporting", "description": "Generate reports on resume scores, user activity, job funnels, coaches, and active users." } ], "paths": { "/instituteApp/v2/coaches": { "post": { "tags": [ "Organization Administration" ], "summary": "List Coaches", "operationId": "post_get_coaches", "security": [ { "cf_api_key": [] } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "createdAt": { "type": "integer" }, "profilePhotoPath": { "type": "string" }, "twitter": { "type": "string" }, "phoneNumber": { "type": "string" }, "normName": { "type": "string" }, "createdBy": { "type": "object", "properties": { "instituteRole": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "instituteRole", "id", "email", "name" ] }, "fullName": { "type": "string" }, "linkedin": { "type": "string" }, "status": { "type": "string" }, "students": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] } }, "totalStudents": { "type": "integer" }, "address": { "type": "string" }, "description": { "type": "string" }, "meetingLink": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "name", "id" ] } } }, "required": [ "email", "firstName", "lastName", "createdAt", "profilePhotoPath", "twitter", "phoneNumber", "normName", "createdBy", "fullName", "linkedin", "status", "students", "totalStudents", "address", "description", "meetingLink", "groups" ] } }, "example": [ { "email": "string", "firstName": "string", "lastName": "string", "createdAt": 0, "profilePhotoPath": "string", "twitter": "string", "phoneNumber": "string", "normName": "string", "createdBy": { "instituteRole": "string", "id": "string", "email": "string", "name": "string" }, "fullName": "string", "linkedin": "string", "status": "string", "students": [ { "name": "string", "email": "string" }, { "name": "string", "email": "string" } ], "totalStudents": 0, "address": "string", "description": "string", "meetingLink": "string", "groups": [ { "name": "string", "id": "string" }, { "name": "string", "id": "string" } ] }, { "email": "string", "firstName": "string", "lastName": "string", "createdAt": 0, "profilePhotoPath": "string", "twitter": "string", "phoneNumber": "string", "normName": "string", "createdBy": { "instituteRole": "string", "id": "string", "email": "string", "name": "string" }, "fullName": "string", "linkedin": "string", "status": "string", "students": [ { "name": "string", "email": "string" }, { "name": "string", "email": "string" } ], "totalStudents": 0, "address": "string", "description": "string", "meetingLink": "string", "groups": [ { "name": "string", "id": "string" }, { "name": "string", "id": "string" } ] } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all coaches in the organization. Results are filtered by the caller's access scope. Supports optional filters and pagination in the request body." } }, "/instituteApp/v2/students": { "post": { "tags": [ "Organization Administration" ], "summary": "List Students", "operationId": "post_get_students", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } }, "required": [ "field", "operator", "value" ] } }, "sort": { "type": "object", "properties": { "field": { "type": "string" }, "order": { "type": "string" } }, "required": [ "field", "order" ] } }, "required": [ "filters", "sort" ] }, "example": { "filters": [ { "field": "status", "operator": "==", "value": "active" } ], "sort": { "field": "fullName", "order": "asc" } } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Student ID" }, "email": { "type": "string", "description": "Student email" }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "fullName": { "type": "string", "description": "Full name" }, "status": { "type": "string", "description": "Student status (active/inactive/deactivated)" }, "groupIds": { "type": "array", "items": { "type": "string" }, "description": "Groups the student belongs to" }, "coachIds": { "type": "array", "items": { "type": "string" }, "description": "Assigned coaches" }, "createdAt": { "type": "integer", "description": "Creation timestamp (milliseconds since epoch)" }, "updatedAt": { "type": "integer", "description": "Last update timestamp (milliseconds since epoch)" } } } }, "example": [ { "id": "abc123", "email": "student@example.com", "firstName": "Jane", "lastName": "Doe", "fullName": "Jane Doe", "status": "active", "groupIds": [ "group1", "group2" ], "coachIds": [ "coach1" ], "createdAt": 1672531200000, "updatedAt": 1672531200000 } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve students in the organization. Pass filters (e.g. status, group) and sort options in the request body. Results are filtered by the caller's access scope." } }, "/instituteApp/v2/addStudent": { "post": { "tags": [ "Organization Administration" ], "summary": "Add Student", "operationId": "post_addstudent", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "status": { "type": "string" }, "fullName": { "type": "string" } }, "required": [ "email", "firstName", "lastName", "status", "fullName" ] }, "example": { "email": "john.smith@example.com", "firstName": "John", "lastName": "Smith", "status": "active", "fullName": "John Smith" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "lastName": { "type": "string" }, "address": { "type": "string" }, "normName": { "type": "string" }, "fullName": { "type": "string" }, "description": { "type": "string" }, "linkedin": { "type": "string" }, "coachIds": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "firstName": { "type": "string" }, "createdAt": { "type": "integer" }, "profilePhotoPath": { "type": "string" }, "twitter": { "type": "string" }, "phoneNumber": { "type": "string" }, "createdBy": { "type": "object", "properties": { "name": { "type": "string" }, "instituteRole": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "instituteRole", "id", "email" ] }, "email": { "type": "string" }, "boards": { "type": "array", "items": { "type": "string" } }, "userId": { "type": "string" }, "jobCreationStats": { "type": "object", "properties": { "2023-09-15": { "type": "integer" }, "2023-11-22": { "type": "integer" }, "2023-12-04": { "type": "integer" }, "2023-05-17": { "type": "integer" }, "2023-06-08": { "type": "integer" }, "2023-11-27": { "type": "integer" }, "2024-04-05": { "type": "integer" }, "2024-04-22": { "type": "integer" }, "2024-05-19": { "type": "integer" } }, "required": [ "2023-09-15", "2023-11-22", "2023-12-04", "2023-05-17", "2023-06-08", "2023-11-27", "2024-04-05", "2024-04-22", "2024-05-19" ] }, "status": { "type": "string" }, "jobData": { "type": "object", "properties": { "total": { "type": "integer" }, "saved": { "type": "integer" }, "applied": { "type": "integer" }, "interviewing": { "type": "integer" }, "offer": { "type": "integer" }, "rejected": { "type": "integer" }, "deleted": { "type": "integer" } }, "required": [ "total", "saved", "applied", "interviewing", "offer", "rejected", "deleted" ] } }, "required": [ "lastName", "address", "normName", "fullName", "description", "linkedin", "coachIds", "tags", "firstName", "createdAt", "profilePhotoPath", "twitter", "phoneNumber", "createdBy", "email", "boards", "userId", "jobCreationStats", "status", "jobData" ] }, "example": { "lastName": "string", "address": "string", "normName": "string", "fullName": "string", "description": "string", "linkedin": "string", "coachIds": [], "tags": [], "firstName": "string", "createdAt": 0, "profilePhotoPath": "string", "twitter": "string", "phoneNumber": "string", "createdBy": { "name": "string", "instituteRole": "string", "id": "string", "email": "string" }, "email": "string", "boards": [ "string", "string" ], "userId": "string", "jobCreationStats": { "2023-09-15": 0, "2023-11-22": 0, "2023-12-04": 0, "2023-05-17": 0, "2023-06-08": 0, "2023-11-27": 0, "2024-04-05": 0, "2024-04-22": 0, "2024-05-19": 0 }, "status": "string", "jobData": { "total": 0, "saved": 0, "applied": 0, "interviewing": 0, "offer": 0, "rejected": 0, "deleted": 0 } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Invite a new student to the organization. An invitation email is sent automatically. The student's email must be unique within the institute." } }, "/instituteApp/v2/updateStudent/{studentId}": { "put": { "tags": [ "Organization Administration" ], "summary": "Update Student", "operationId": "put_update_student_information", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "studentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Student ID or email address." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "coachIds": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profilePhotoPath": { "type": "string" } }, "required": [ "email", "firstName", "lastName", "profilePhotoPath" ] } } }, "required": [ "coachIds" ] }, "example": { "coachIds": [ { "email": "string", "firstName": "string", "lastName": "string", "profilePhotoPath": "string" }, { "email": "string", "firstName": "string", "lastName": "string", "profilePhotoPath": "string" } ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_writeTime": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] } }, "required": [ "_writeTime" ] }, "example": { "_writeTime": { "_seconds": 0, "_nanoseconds": 0 } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Update an existing student's information using their email address. Supports partial updates — only include the fields you want to change." } }, "/instituteApp/v2/studentsDetails/{studentId}": { "get": { "tags": [ "Organization Administration" ], "summary": "Get Student Details", "operationId": "get_student_details", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "studentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Student ID or email address." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "lastName": { "type": "string" }, "address": { "type": "string" }, "normName": { "type": "string" }, "fullName": { "type": "string" }, "description": { "type": "string" }, "linkedin": { "type": "string" }, "coachIds": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "firstName": { "type": "string" }, "createdAt": { "type": "integer" }, "profilePhotoPath": { "type": "string" }, "twitter": { "type": "string" }, "phoneNumber": { "type": "string" }, "createdBy": { "type": "object", "properties": { "name": { "type": "string" }, "instituteRole": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "instituteRole", "id", "email" ] }, "email": { "type": "string" }, "boards": { "type": "array", "items": { "type": "string" } }, "userId": { "type": "string" }, "jobCreationStats": { "type": "object", "properties": { "2023-09-15": { "type": "integer" }, "2023-11-22": { "type": "integer" }, "2023-12-04": { "type": "integer" }, "2023-05-17": { "type": "integer" }, "2023-06-08": { "type": "integer" }, "2023-11-27": { "type": "integer" }, "2024-04-05": { "type": "integer" }, "2024-04-22": { "type": "integer" }, "2024-05-19": { "type": "integer" } }, "required": [ "2023-09-15", "2023-11-22", "2023-12-04", "2023-05-17", "2023-06-08", "2023-11-27", "2024-04-05", "2024-04-22", "2024-05-19" ] }, "status": { "type": "string" }, "jobData": { "type": "object", "properties": { "total": { "type": "integer" }, "saved": { "type": "integer" }, "applied": { "type": "integer" }, "interviewing": { "type": "integer" }, "offer": { "type": "integer" }, "rejected": { "type": "integer" }, "deleted": { "type": "integer" } }, "required": [ "total", "saved", "applied", "interviewing", "offer", "rejected", "deleted" ] } }, "required": [ "lastName", "address", "normName", "fullName", "description", "linkedin", "coachIds", "tags", "firstName", "createdAt", "profilePhotoPath", "twitter", "phoneNumber", "createdBy", "email", "boards", "userId", "jobCreationStats", "status", "jobData" ] }, "example": { "lastName": "string", "address": "string", "normName": "string", "fullName": "string", "description": "string", "linkedin": "string", "coachIds": [], "tags": [], "firstName": "string", "createdAt": 0, "profilePhotoPath": "string", "twitter": "string", "phoneNumber": "string", "createdBy": { "name": "string", "instituteRole": "string", "id": "string", "email": "string" }, "email": "string", "boards": [ "string", "string" ], "userId": "string", "jobCreationStats": { "2023-09-15": 0, "2023-11-22": 0, "2023-12-04": 0, "2023-05-17": 0, "2023-06-08": 0, "2023-11-27": 0, "2024-04-05": 0, "2024-04-22": 0, "2024-05-19": 0 }, "status": "string", "jobData": { "total": 0, "saved": 0, "applied": 0, "interviewing": 0, "offer": 0, "rejected": 0, "deleted": 0 } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve detailed information about a specific student by their email address, including profile data, group memberships, and invite status." } }, "/instituteApp/v2/resource": { "get": { "tags": [ "Organization Administration" ], "summary": "List Resources", "operationId": "get_get_all_resources", "security": [ { "cf_api_key": [] } ], "responses": { "200": { "description": "Get All resources", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "resourceId": { "type": "string" }, "subtitle": { "type": "string" }, "category": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "resourceId", "subtitle", "category", "title", "url" ] } }, "example": [ { "id": "GvAVc0vCDiVqb9I67IP5", "resourceId": "GvAVc0vCDiVqb9I67IP5", "subtitle": "How to use ChatGPT for Job Search", "category": "Guides", "title": "ChatGPT Guides", "url": "https://www.careerflow.ai/chatgpt-guides" }, { "subtitle": "Test Resouce", "id": "SEjSnLq4df4UX5N92X9S", "title": "New Resource", "category": "Resume", "url": "https://example.com/resources/resume-guide" } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all resources (links, files) shared within the organization." }, "put": { "tags": [ "Organization Administration" ], "summary": "Update Resource", "operationId": "put_edit_resource", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "string" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "url": { "type": "string" }, "category": { "type": "string" } }, "required": [ "resourceId", "title", "subtitle", "url", "category" ] }, "example": { "resourceId": "01no3PpweMObuDbdCZg0", "title": "ChatGPT", "subtitle": "How to use ChatGPT for Job Search", "url": "https://www.careerflow.ai/chatgpt-guides", "category": "References" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Update an existing resource. The `resourceId` field is required in the request body to identify which resource to update." }, "post": { "tags": [ "Organization Administration" ], "summary": "Create Resource", "operationId": "post_save_resource", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "subtitle": { "type": "string" }, "url": { "type": "string" }, "category": { "type": "string" } }, "required": [ "title", "subtitle", "url", "category" ] }, "example": { "title": "Sample", "subtitle": "This is sample resource", "url": "https://example.com/resources/sample-resource", "category": "References" } } } }, "responses": { "200": { "description": "Save Resource Response", "content": { "application/json": { "schema": { "type": "string" }, "example": "LA6RD3zbJZLnmg7nhGGp" } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Add a new resource (link or file) to the organization's shared resource library." } }, "/instituteApp/v2/group": { "put": { "tags": [ "Organization Administration" ], "summary": "Update Group", "operationId": "put_edit_group", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "students": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "coaches": { "type": "array", "items": { "type": "object", "properties": { "profilePhotoPath": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" }, "profilePic": { "type": "string" } }, "required": [ "profilePhotoPath", "name", "id", "profilePic" ] } }, "participantsCount": { "type": "integer" }, "coachAdded": { "type": "array", "items": { "type": "string" } }, "coachRemoved": { "type": "array", "items": { "type": "string" } }, "studentRemoved": { "type": "array", "items": { "type": "string" } }, "studentAdded": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "name", "description", "students", "coaches", "participantsCount", "coachAdded", "coachRemoved", "studentRemoved", "studentAdded" ] }, "example": { "groupId": "SINDxN3mHhOjOSuRhCjv", "name": "New Group", "description": "This is to add new group to an org", "students": [ { "id": "alex.jones@example.com", "name": "Alex Jones" } ], "coaches": [ { "profilePhotoPath": "", "name": "Emily Chen", "id": "coach1@example.com", "profilePic": "" }, { "profilePhotoPath": "", "name": "Sam Wilson", "id": "sam.wilson@example.com", "profilePic": "" } ], "participantsCount": 3, "coachAdded": [], "coachRemoved": [], "studentRemoved": [ "jane.doe@example.com" ], "studentAdded": [] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Update group details such as name, description, or membership. Use `studentAdded`/`studentRemoved` and `coachAdded`/`coachRemoved` arrays to modify members." } }, "/instituteApp/v2/getGroup": { "post": { "tags": [ "Organization Administration" ], "summary": "List Groups", "operationId": "post_get_groups", "security": [ { "cf_api_key": [] } ], "responses": { "200": { "description": "Get Groups Sample Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "coaches": { "type": "array", "items": { "type": "object", "properties": { "profilePhotoPath": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "profilePhotoPath", "name", "id" ] } }, "participantsCount": { "type": "integer" }, "createdAt": { "type": "integer" }, "createdBy": { "type": "object", "properties": { "profilePhotoPath": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" } }, "required": [ "profilePhotoPath", "name", "id", "email" ] }, "name": { "type": "string" }, "students": { "type": "array", "items": { "type": "object", "properties": { "profilePhotoPath": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "profilePhotoPath", "name", "id" ] } }, "description": { "type": "string" }, "id": { "type": "string" } }, "required": [ "coaches", "participantsCount", "createdAt", "createdBy", "name", "students", "description", "id" ] } }, "example": [ { "coaches": [ { "profilePhotoPath": "", "name": "Emily Chen", "id": "coach1@example.com" }, { "profilePhotoPath": "", "name": "Alex Jones", "id": "coach2@example.com" } ], "participantsCount": 3, "createdAt": 1722353852406, "createdBy": { "profilePhotoPath": "profilePhotoBucket/example-user-id", "name": "Admin User", "id": "admin@example.com", "email": "admin@example.com" }, "name": "Group - A", "students": [ { "profilePhotoPath": "", "name": "Student One", "id": "student1@example.com" } ], "description": "This is sample description", "id": "cViLy0gxkP1GICiplBnA" }, { "participantsCount": 2, "createdAt": 1722354245298, "createdBy": { "profilePhotoPath": "profilePhotoBucket/example-user-id", "name": "Admin User", "id": "admin@example.com", "email": "admin@example.com" }, "name": "Group - I", "description": "This is sample group", "id": "gW7waQvR83mPlqOw9Cno", "coaches": [ { "profilePhotoPath": "", "profilePic": "", "name": "Coach Demo", "id": "coach3@example.com" } ], "studentAdded": [ "jane.doe@example.com" ], "groupId": "gW7waQvR83mPlqOw9Cno", "coachRemoved": [], "studentRemoved": [], "students": [ { "profilePhotoPath": "", "name": "Jane Doe", "id": "jane.doe@example.com" } ], "coachAdded": [] } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all groups in the organization. Results are filtered by the caller's access scope." } }, "/instituteApp/v2/addGroup": { "post": { "tags": [ "Organization Administration" ], "summary": "Create Group", "operationId": "post_add_group", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "students": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "profilePhotoPath": { "type": "string" } }, "required": [ "id", "name", "profilePhotoPath" ] } }, "coaches": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "profilePhotoPath": { "type": "string" } }, "required": [ "id", "name", "profilePhotoPath" ] } }, "createdBy": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "profilePhotoPath": { "type": "string" } }, "required": [ "id", "name", "email", "profilePhotoPath" ] } }, "required": [ "name", "description", "students", "coaches", "createdBy" ] }, "example": { "name": "New Group", "description": "This is to add new group to an org", "students": [ { "id": "jane.doe@example.com", "name": "Jane Doe", "profilePhotoPath": "" }, { "id": "alex.jones@example.com", "name": "Alex Jones" } ], "coaches": [ { "id": "coach1@example.com", "name": "Emily Chen", "profilePhotoPath": "" }, { "id": "sam.wilson@example.com", "name": "Sam Wilson", "profilePhotoPath": "" } ], "createdBy": { "id": "admin@example.com", "name": "Admin User", "email": "admin@example.com", "profilePhotoPath": "profilePhotoBucket/example-user-id" } } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Create a new group with an optional initial set of students and coaches." } }, "/instituteApp/v2/group/{groupId}": { "delete": { "tags": [ "Organization Administration" ], "summary": "Delete Group", "operationId": "delete_delete_group", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The groupId identifier." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Permanently delete a group by its ID. All students and coaches are removed from the group automatically. This does not delete the students or coaches themselves." } }, "/jobTracker/v2/goalsProgress": { "get": { "tags": [ "Organization Administration" ], "summary": "Get Student Goal Progress", "operationId": "get_jobtrackergoalsprogress", "security": [ { "cf_api_key": [] } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve goal progress for a specific student. Returns all active goals with their current completion status, target values, and linked items (jobs or contacts). Pass `userId` as a query parameter to look up a specific student." } }, "/jobTracker/v2/goals/{instituteId}": { "get": { "tags": [ "Organization Administration" ], "summary": "List Institute Goals", "operationId": "get_institute_goals", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all goals defined for an institute and the aggregated progress across students. Supports optional `weekId` or `monthId` query parameters to filter by time period. Pass `excel=true` to export as an Excel file." } }, "/instituteApp/v2/institute/{instituteId}/checklist/{checklistId}": { "get": { "tags": [ "Organization Administration" ], "summary": "Get Checklist Details", "operationId": "get_checklist_details", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." }, { "name": "checklistId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The checklistId identifier." } ], "responses": { "200": { "description": "Get Checklist Details", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "type": "integer" }, "createdBy": { "type": "object", "properties": { "name": { "type": "string" }, "instituteRole": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "instituteRole", "id", "email" ] }, "groupIds": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "coachIds": { "type": "array", "items": { "type": "string" } }, "checklistItems": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "integer" }, "actionText": { "type": "string" }, "createdBy": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" } }, "required": [ "id", "email", "username" ] }, "actionUrl": { "type": "string" }, "description": { "type": "string" }, "index": { "type": "integer" }, "id": { "type": "string" }, "title": { "type": "string" }, "deactivated": { "type": "boolean" } }, "required": [ "createdAt", "actionText", "createdBy", "actionUrl", "description", "index", "id", "title", "deactivated" ] } } }, "required": [ "createdAt", "createdBy", "groupIds", "scope", "description", "id", "title", "coachIds", "checklistItems" ] }, "example": { "createdAt": 1723623996546, "createdBy": { "name": "Chris Lee", "instituteRole": "COACH", "id": "exampleCoachId456", "email": "chris.lee@example.com" }, "groupIds": [ "gW7waQvR83mPlqOw9Cno" ], "scope": "GROUP", "description": "", "id": "lHAPZpi6CdwkscabBaM0", "title": "New checklist with group", "coachIds": [], "checklistItems": [ { "createdAt": 1723623996614, "actionText": "First Item", "createdBy": { "id": "exampleCoachId456", "email": "chris.lee@example.com", "username": "Chris Lee" }, "actionUrl": "", "description": "", "index": 0, "id": "JWkKhidJd7D1UOKEeepY", "title": "First Item", "deactivated": false } ] } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve a specific checklist by ID, including all its items." } }, "/instituteApp/v2/institute/{instituteId}/checklist/{checklistId}/progress": { "get": { "tags": [ "Organization Administration" ], "summary": "Get Checklist Progress", "operationId": "get_checklist_progress", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." }, { "name": "checklistId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The checklistId identifier." } ], "responses": { "200": { "description": "Checklist progress", "content": { "application/json": { "schema": { "type": "object", "properties": { "checklistDetails": { "type": "object", "properties": { "createdAt": { "type": "integer" }, "createdBy": { "type": "object", "properties": { "name": { "type": "string" }, "instituteRole": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "instituteRole", "id", "email" ] }, "groupIds": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "coachIds": { "type": "array", "items": { "type": "string" } }, "checklistItems": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "integer" }, "actionText": { "type": "string" }, "createdBy": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" } }, "required": [ "id", "email", "username" ] }, "actionUrl": { "type": "string" }, "description": { "type": "string" }, "index": { "type": "integer" }, "id": { "type": "string" }, "title": { "type": "string" }, "deactivated": { "type": "boolean" } }, "required": [ "createdAt", "actionText", "createdBy", "actionUrl", "description", "index", "id", "title", "deactivated" ] } } }, "required": [ "createdAt", "createdBy", "groupIds", "scope", "description", "id", "title", "coachIds", "checklistItems" ] }, "studentChecklistProgress": { "type": "array", "items": { "type": "object", "properties": { "studentDetails": { "type": "object", "properties": { "email": { "type": "string" }, "userId": { "type": "string" }, "fullName": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "name", "id" ] } }, "creationDate": { "type": "integer" } }, "required": [ "email", "userId", "fullName", "groups", "creationDate" ] }, "checklistCompletionDetails": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "itemCompletionDate": { "type": "string" }, "completed": { "type": "boolean" } }, "required": [ "itemId", "itemCompletionDate", "completed" ] } } }, "required": [ "studentDetails", "checklistCompletionDetails" ] } } }, "required": [ "checklistDetails", "studentChecklistProgress" ] }, "example": { "checklistDetails": { "createdAt": 1723623996546, "createdBy": { "name": "Chris Lee", "instituteRole": "COACH", "id": "exampleCoachId456", "email": "chris.lee@example.com" }, "groupIds": [ "gW7waQvR83mPlqOw9Cno" ], "scope": "GROUP", "description": "", "id": "lHAPZpi6CdwkscabBaM0", "title": "New checklist with group", "coachIds": [], "checklistItems": [ { "createdAt": 1723623996614, "actionText": "First Item", "createdBy": { "id": "exampleCoachId456", "email": "chris.lee@example.com", "username": "Chris Lee" }, "actionUrl": "", "description": "", "index": 0, "id": "JWkKhidJd7D1UOKEeepY", "title": "First Item", "deactivated": false } ] }, "studentChecklistProgress": [ { "studentDetails": { "email": "jane.doe@example.com", "userId": "exampleUserId123", "fullName": "Jane Doe", "groups": [ { "name": "New Group", "id": "eHOWFqYxIwY5xDLHzICI" }, { "name": "Group - I", "id": "gW7waQvR83mPlqOw9Cno" } ], "creationDate": 1685008561203 }, "checklistCompletionDetails": [ { "itemId": "JWkKhidJd7D1UOKEeepY", "itemCompletionDate": null, "completed": false } ] } ] } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve completion progress for a checklist across all assigned students. Each student's per-item completion status is included. Supports optional `weekId` or `monthId` query parameters to filter by time period. Pass `excel=true` to export as an Excel file." } }, "/jobTracker/v2/documents": { "get": { "tags": [ "Job Seeker Management" ], "summary": "List Documents", "operationId": "get_list_all_documents", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "responses": { "200": { "description": "Example Request", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "resumeId": { "type": "string" }, "created": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] }, "description": { "type": "string" }, "category": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "isActive": { "type": "boolean" }, "id": { "type": "string" } }, "required": [ "resumeId", "created", "description", "category", "type", "title", "isActive", "id" ] } }, "example": [ { "resumeId": "string", "created": { "_seconds": 0, "_nanoseconds": 0 }, "description": "string", "category": "string", "type": "string", "title": "string", "isActive": true, "id": "string" }, { "resumeId": "string", "created": { "_seconds": 0, "_nanoseconds": 0 }, "description": "string", "category": "string", "type": "string", "title": "string", "isActive": true, "id": "string" } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all documents for a student. Pass `userId` as a query parameter to specify the student. Supports filtering by resume ID, board ID, or job card ID." } }, "/jobTracker/v2/contacts": { "post": { "tags": [ "Job Seeker Management" ], "summary": "Create Contact", "operationId": "post_list_all_contacts", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName", "lastName" ], "properties": { "firstName": { "type": "string", "description": "Contact's first name" }, "lastName": { "type": "string", "description": "Contact's last name" }, "email": { "type": "string", "description": "Contact's email address" }, "linkedin": { "type": "string", "description": "LinkedIn profile URL" }, "company": { "type": "string", "description": "Company name" }, "position": { "type": "string", "description": "Job title or position" } } } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Create a new contact for the specified user. To list contacts, use GET /jobTracker/v2/contacts with a userId query parameter, or use POST /jobTracker/v2/v2/contacts for filtered listing." } }, "/jobTracker/v2/board": { "get": { "tags": [ "Job Seeker Management" ], "summary": "List Job Boards", "operationId": "get_list_job_tracker", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "deletedJobCardList": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "sectionList": { "type": "array", "items": { "type": "object", "properties": { "jobCardsPosition": { "type": "array", "items": { "type": "integer" } }, "modifiedDate": { "type": "integer" }, "position": { "type": "integer" }, "title": { "type": "string" } }, "required": [ "jobCardsPosition", "modifiedDate", "position", "title" ] } }, "jobCardList": { "type": "object", "properties": { "1": { "type": "object", "properties": { "sectionName": { "type": "string" }, "companyId": { "type": "string" }, "creator": { "type": "object", "properties": { "name": { "type": "string" }, "userId": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "userId", "email" ] }, "jobCardId": { "type": "integer" }, "companyLogoUrl": { "type": "string" }, "companyName": { "type": "string" }, "jobTitle": { "type": "string" }, "logo": { "type": "string" }, "postingDate": { "type": "integer" }, "isActive": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "jobcardId": { "type": "string" } }, "required": [ "sectionName", "companyId", "creator", "jobCardId", "companyLogoUrl", "companyName", "jobTitle", "logo", "postingDate", "isActive", "tags", "jobcardId" ] }, "2": { "type": "object", "properties": { "sectionName": { "type": "string" }, "companyId": { "type": "string" }, "notes": { "type": "array", "items": { "type": "string" } }, "jobCardId": { "type": "integer" }, "jobTitle": { "type": "string" }, "companyName": { "type": "string" }, "jobUrl": { "type": "string" }, "logo": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "string" }, "lastModified": { "type": "integer" }, "jobcardId": { "type": "string" } }, "required": [ "sectionName", "companyId", "notes", "jobCardId", "jobTitle", "companyName", "jobUrl", "logo", "description", "location", "lastModified", "jobcardId" ] } }, "required": [ "1", "2" ] } }, "required": [ "id", "deletedJobCardList", "title", "sectionList", "jobCardList" ] }, "example": { "id": "string", "deletedJobCardList": [], "title": "string", "sectionList": [ { "jobCardsPosition": [ 0, 0 ], "modifiedDate": 0, "position": 0, "title": "string" }, { "jobCardsPosition": [ 0, 0 ], "modifiedDate": 0, "position": 0, "title": "string" } ], "jobCardList": { "1": { "sectionName": "string", "companyId": "string", "creator": { "name": "string", "userId": "string", "email": "string" }, "jobCardId": 0, "companyLogoUrl": "string", "companyName": "string", "jobTitle": "string", "logo": "string", "postingDate": 0, "isActive": true, "tags": [], "jobcardId": "string" }, "2": { "sectionName": "string", "companyId": "string", "notes": [], "jobCardId": 0, "jobTitle": "string", "companyName": "string", "jobUrl": "string", "logo": "string", "description": "string", "location": "string", "lastModified": 0, "jobcardId": "string" } } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve a student's job board with its sections and job cards. Pass `userId` as a query parameter to specify the student." } }, "/ai-services/v1/resume/optimize": { "post": { "tags": [ "Resume Builder" ], "summary": "Optimize Resume", "operationId": "post_optimize_resume_resume_id_and_job_id", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "example": "{userId}" }, "resume_id": { "type": "string", "example": "{resumeId}" }, "job_id": { "type": "string", "example": "{jobId}" } }, "required": [ "user_id", "resume_id", "job_id" ] } } } }, "responses": { "200": { "description": "Example", "content": { "application/json": { "schema": { "type": "object", "properties": { "optimized_resume": { "type": "object", "properties": { "result": { "type": "object", "properties": { "sections": { "type": "object", "properties": { "certifications": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "profiles": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "username": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "icon": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "id": { "type": "integer" }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "network": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "username", "visible", "icon", "id", "url", "network" ] } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "references": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "volunteering": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "summary": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" } }, "required": [ "text", "visible", "id" ] } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "interests": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "awards": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "id": { "type": "integer" }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "title": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "awarder": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "date", "visible", "id", "summary", "url", "title", "awarder" ] } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "skills": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "keywords": { "type": "array", "items": { "type": "string" } }, "category": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "level": { "type": "integer" }, "skills": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } } }, "required": [ "description", "visible", "id", "keywords", "category", "level", "skills" ] } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "publications": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "experience": { "type": "object", "properties": { "totalYearsExperience": { "type": "integer" }, "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" } }, "required": [ "text", "visible", "id" ] } }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "currentlyWorkHere": { "type": "boolean" }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "company": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endYear": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "position": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "remotePosition": { "type": "boolean" }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "description", "visible", "id", "summary", "url", "currentlyWorkHere", "city", "startMonth", "startYear", "company", "date", "country", "endYear", "position", "remotePosition", "location", "endMonth" ] } }, "columns": { "type": "integer" } }, "required": [ "totalYearsExperience", "name", "visible", "id", "items", "columns" ] }, "projects": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "languages": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "education": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "endDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "description": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" } }, "required": [ "text", "visible", "id" ] } }, "degree": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "studyType": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "id": { "type": "string" }, "startMonth": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "area": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "currentlyStudyHere": { "type": "boolean" }, "endYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "institution": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "score": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "endDate", "visible", "description", "degree", "summary", "url", "studyType", "id", "startMonth", "city", "area", "startYear", "date", "country", "currentlyStudyHere", "endYear", "institution", "score", "location", "startDate", "endMonth" ] } }, "columns": { "type": "integer" } }, "required": [ "name", "visible", "id", "items", "columns" ] }, "custom": { "type": "object", "properties": {} } }, "required": [ "certifications", "profiles", "references", "volunteering", "summary", "interests", "awards", "skills", "publications", "experience", "projects", "languages", "education", "custom" ] }, "generateSourceId": { "type": "integer" }, "metadata": { "type": "object", "properties": { "template": { "type": "string" }, "typography": { "type": "object", "properties": { "hideIcons": { "type": "boolean" }, "font": { "type": "object", "properties": { "variants": { "type": "array", "items": { "type": "string" } }, "size": { "type": "integer" }, "family": { "type": "string" }, "subset": { "type": "string" } }, "required": [ "variants", "size", "family", "subset" ] }, "lineHeight": { "type": "number" }, "underlineLinks": { "type": "boolean" } }, "required": [ "hideIcons", "font", "lineHeight", "underlineLinks" ] }, "layout": { "type": "array", "items": { "type": "object", "properties": { "sectionName": { "type": "string" } }, "required": [ "sectionName" ] } }, "theme": { "type": "object", "properties": { "background": { "type": "string" }, "text": { "type": "string" }, "primary": { "type": "string" } }, "required": [ "background", "text", "primary" ] }, "page": { "type": "object", "properties": { "format": { "type": "string" }, "margin": { "type": "integer" }, "options": { "type": "object", "properties": { "breakLine": { "type": "boolean" }, "pageNumbers": { "type": "boolean" } }, "required": [ "breakLine", "pageNumbers" ] } }, "required": [ "format", "margin", "options" ] }, "css": { "type": "object", "properties": { "value": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "value", "visible" ] }, "notes": { "type": "string" } }, "required": [ "template", "typography", "layout", "theme", "page", "css", "notes" ] }, "basics": { "type": "object", "properties": { "email": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "headline": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "openToRemote": { "type": "boolean" }, "rawName": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "openToRelocate": { "type": "boolean" }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "postalCode": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "dob": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "customFields": { "type": "array", "items": { "type": "string" } }, "phone": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "picture": { "type": "object", "properties": { "effects": { "type": "object", "properties": { "grayscale": { "type": "boolean" }, "hidden": { "type": "boolean" }, "border": { "type": "boolean" } }, "required": [ "grayscale", "hidden", "border" ] }, "size": { "type": "integer" }, "aspectRatio": { "type": "integer" }, "url": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "borderRadius": { "type": "integer" } }, "required": [ "effects", "size", "aspectRatio", "url", "borderRadius" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "targetJobTitle": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "lname": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "address": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "gender": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "fname": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "nationality": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "email", "headline", "url", "openToRemote", "rawName", "openToRelocate", "city", "postalCode", "dob", "customFields", "phone", "picture", "country", "targetJobTitle", "lname", "address", "gender", "fname", "location", "state", "nationality" ] } }, "required": [ "sections", "generateSourceId", "metadata", "basics" ] } }, "required": [ "result" ] }, "percent_change": { "type": "integer" }, "optimized_resume_download_id": { "type": "string" }, "optimized_resume_editor_id": { "type": "string" }, "optimized_resume_download_url": { "type": "string" } }, "required": [ "optimized_resume", "percent_change", "optimized_resume_download_id", "optimized_resume_editor_id", "optimized_resume_download_url" ] }, "example": { "optimized_resume": { "result": { "sections": { "certifications": { "name": "Certifications", "visible": true, "id": "certifications", "items": [], "columns": 1 }, "profiles": { "name": "Profiles", "visible": true, "id": "profiles", "items": [ { "username": { "text": "", "visible": false }, "visible": true, "icon": { "text": "", "visible": false }, "id": "1", "url": { "href": "https://www.linkedin.com/in/example-user/", "visible": false, "label": "LinkedIn" }, "network": { "text": "LinkedIn Profile", "visible": true } } ], "columns": 1 }, "references": { "name": "References", "visible": true, "id": "references", "items": [], "columns": 1 }, "volunteering": { "name": "Volunteering", "visible": true, "id": "volunteering", "items": [], "columns": 1 }, "summary": { "name": "Summary", "visible": true, "id": "summary", "items": [ { "text": "Hey there, I'm Jane Doe, a Software Engineer with 2+ years of experience in building scalable web applications using Python and Django. Currently, I am working as an SWE at Careerflow.ai, where I am developing an AI-powered career co-pilot to help job seekers navigate their careers more effectively.\n\nDuring my time at Tathya, I worked as a full-stack software engineer and developed multiple RESTful APIs using Django and React components for the web app. Additionally, I built multiple internal tools.\n\nAt Cogno AI, I worked on the Campaign team as a Software Engineer 2. My responsibilities included developing and maintaining web applications using Django and JavaScript.\n\nI have experience working with distributed systems, PostgreSQL, Django REST Framework, React.js, RabbitMQ, Vue.js, NestJS, JavaScript and have overhauled existing satellite image processing pipelines. Additionally, I have written scheduling systems to repeatedly push tasks on regular intervals.\n\nI graduated with a Bachelor of Engineering in Computer Engineering from Fr. Conceicao Rodrigues Institute of Technology in Mumbai and have completed coursework in Data Structures, Design and analysis of Algorithms, Computer Architecture, Database Systems, Operating Systems, Natural Language Processing and Artificial Intelligence.\n\nIn my free time, you can find me playing volleyball or participating in coding competitions like Google Code Jam Qualification Round 2020 (Qualified), CSI Computer FCRIT Codesprint - 2nd Position or TechGig Code Gladiators SemiFinals 2019 - Rank 2161.\n\nIf you're looking for someone who is passionate about software engineering and has experience building scalable web applications using Python and Django then let's connect!", "visible": true, "id": "894a2f4e-5ecd-46b5-a7f3-61440e496a27" } ], "columns": 1 }, "interests": { "name": "Interests", "visible": false, "id": "interests", "items": [], "columns": 1 }, "awards": { "name": "Awards", "visible": true, "id": "awards", "items": [ { "date": { "text": "2006-10-31T18:30:00.000Z", "visible": true }, "visible": true, "id": "49", "summary": { "text": "
Won 2nd price for CSI
", "visible": true }, "url": { "href": "https://jsonformatter.org/", "visible": true, "label": "" }, "title": { "text": "CSI - FCRIT", "visible": true }, "awarder": { "text": "FCRIT", "visible": true } } ], "columns": 1 }, "skills": { "name": "Skills", "visible": true, "id": "skills", "items": [ { "description": { "text": "", "visible": false }, "visible": true, "id": "a4b5312a-ee73-4b30-9b0d-06aaabd04edf", "keywords": [], "category": { "text": "Top Skills", "visible": true }, "level": 1, "skills": [ { "text": "Vector Database", "visible": true }, { "text": "React", "visible": true } ] } ], "columns": 1 }, "publications": { "name": "Publications", "visible": true, "id": "publications", "items": [], "columns": 1 }, "experience": { "totalYearsExperience": 5, "name": "Experience", "visible": true, "id": "experience", "items": [ { "description": [ { "text": "Coordinated and oversaw the renovation of multiple residential properties, leading to a 15% increase in rental rates and a 20% decrease in vacant units.", "visible": true, "id": "414a8735-a4c6-4469-ba4c-8a469d9b05f3" }, { "text": "Devised skill-matching algorithms enhancing the accuracy of assessing resumes against job descriptions, employing effective methodologies and skill ranking techniques.", "visible": true, "id": "0481b94c-9c23-418b-8ec6-b60110d67bef" } ], "visible": true, "id": "ebb93f3b-6421-4ac5-9fea-97dc4b4998bc", "summary": { "text": "", "visible": false }, "url": { "href": "", "visible": false, "label": "" }, "currentlyWorkHere": true, "city": { "text": "", "visible": true }, "startMonth": { "text": 5, "visible": true }, "startYear": { "text": "2023", "visible": true }, "company": { "text": "Careerflow.ai (Techstars '23) ", "visible": true }, "date": { "text": "May 2023 - Present · 1 yr 1 mo", "visible": true }, "country": { "text": "", "visible": true }, "endYear": { "text": "", "visible": true }, "position": { "text": "SWE", "visible": true }, "remotePosition": false, "location": { "text": "Remote", "visible": true }, "endMonth": { "text": "", "visible": true } }, { "description": [ { "text": "Worked for the Campaign team.", "visible": true, "id": "a565aa1f-776e-43c7-ab18-5d01619bdcf8" } ], "visible": true, "id": "d3cb4b49-7740-4d49-9f0e-0a8459e60577", "summary": { "text": "", "visible": false }, "url": { "href": "", "visible": false, "label": "" }, "currentlyWorkHere": false, "city": { "text": "Mumbai", "visible": true }, "startMonth": { "text": 10, "visible": true }, "startYear": { "text": "2022", "visible": true }, "company": { "text": "Cogno AI ", "visible": true }, "date": { "text": "Oct 2022 - Jan 2023 · 4 mos", "visible": true }, "country": { "text": "", "visible": true }, "endYear": { "text": "2023", "visible": true }, "position": { "text": "Software Engineer 2", "visible": true }, "remotePosition": false, "location": { "text": "Mumbai · Remote", "visible": true }, "endMonth": { "text": 1, "visible": true } } ], "columns": 1 }, "projects": { "name": "Projects", "visible": true, "id": "projects", "items": [], "columns": 1 }, "languages": { "name": "Languages", "visible": false, "id": "languages", "items": [], "columns": 1 }, "education": { "name": "Education", "visible": true, "id": "education", "items": [ { "endDate": { "text": "", "visible": true }, "visible": true, "description": [ { "text": "Main coursework: Data Structures, Design and analysis of Algorithms, Computer Architecture, Database Systems, Operating Systems, Natural Language Processing, Artificial Intelligence", "visible": true, "id": "026d004f-fd24-4f40-b43f-4db970420ca5" } ], "degree": { "text": "Bachelor of Engineering - BE", "visible": true }, "summary": { "text": "", "visible": true }, "url": { "href": "", "visible": false, "label": "" }, "studyType": { "text": "Bachelor of Engineering - BE, Computer Engineering", "visible": true }, "id": "ec6b0ae8-d629-45cb-a89c-cc7b895735ef", "startMonth": { "text": "", "visible": true }, "city": { "text": "", "visible": true }, "area": { "text": "Computer Engineering", "visible": true }, "startYear": { "text": "2017", "visible": true }, "date": { "text": "2017 - 2021", "visible": true }, "country": { "text": "", "visible": true }, "currentlyStudyHere": false, "endYear": { "text": "2021", "visible": true }, "institution": { "text": "Fr. Conceicao Rodrigues Institute of Technology", "visible": true }, "score": { "text": "", "visible": true }, "location": { "text": "", "visible": true }, "startDate": { "text": "", "visible": true }, "endMonth": { "text": "", "visible": true } }, { "endDate": { "text": "", "visible": true }, "visible": true, "description": [], "degree": { "text": "Bachelor of Engineering - BE", "visible": true }, "summary": { "text": "", "visible": true }, "url": { "href": "", "visible": false, "label": "" }, "studyType": { "text": "Bachelor of Engineering - BE, Computer Engineering", "visible": true }, "id": "e3eb26c2-0c0a-4a66-b36f-7c73fc21aecc", "startMonth": { "text": 8, "visible": true }, "city": { "text": "", "visible": true }, "area": { "text": "Computer Engineering", "visible": true }, "startYear": { "text": "2017", "visible": true }, "date": { "text": "Aug 2017 - May 2021", "visible": true }, "country": { "text": "", "visible": true }, "currentlyStudyHere": false, "endYear": { "text": "2021", "visible": true }, "institution": { "text": "University of Mumbai", "visible": true }, "score": { "text": "", "visible": true }, "location": { "text": "", "visible": true }, "startDate": { "text": "", "visible": true }, "endMonth": { "text": 5, "visible": true } } ], "columns": 1 }, "custom": {} }, "generateSourceId": "1714740304964", "metadata": { "template": "Faangpath", "typography": { "hideIcons": false, "font": { "variants": [ "regular", "italic" ], "size": 14, "family": "IBM Plex Serif", "subset": "latin" }, "lineHeight": 1.5, "underlineLinks": true }, "layout": [ { "sectionName": "summary" }, { "sectionName": "experience" } ], "theme": { "background": "#ffffff", "text": "#000000", "primary": "#dc2626" }, "page": { "format": "a4", "margin": 18, "options": { "breakLine": true, "pageNumbers": true } }, "css": { "value": ".section {\n\toutline: 1px solid #000;\n\toutline-offset: 4px;\n}", "visible": false }, "notes": "" }, "basics": { "email": { "text": "jane.doe@example.com", "visible": true }, "headline": { "text": "Software Engineer | Example Corp", "visible": true }, "url": { "href": "https://www.linkedin.com/in/example-user/", "visible": false, "label": "" }, "openToRemote": false, "rawName": { "text": "Jane Doe", "visible": true }, "openToRelocate": false, "city": { "text": "Mumbai", "visible": true }, "postalCode": { "text": "", "visible": true }, "dob": { "text": "1990-01-01T00:00:00.000Z", "visible": false }, "customFields": [], "phone": { "text": "555-0101", "visible": true }, "picture": { "effects": { "grayscale": false, "hidden": false, "border": false }, "size": 64, "aspectRatio": 1, "url": { "text": "", "visible": true }, "borderRadius": 0 }, "country": { "text": "India", "visible": true }, "targetJobTitle": { "text": "Property Manager", "visible": true }, "lname": { "text": "Sam", "visible": true }, "address": { "text": "", "visible": true }, "gender": { "text": "Male", "visible": false }, "fname": { "text": "Jeffy", "visible": true }, "location": { "text": "Mumbai, Maharashtra, India", "visible": true }, "state": { "text": "Maharashtra", "visible": true }, "nationality": { "text": "", "visible": false } } } }, "percent_change": 200, "optimized_resume_download_id": "e6733d1a-b68f-4056-a011-d138f9392c5f", "optimized_resume_editor_id": "u6rNivfEbZwANgotQ6Yw", "optimized_resume_download_url": "https://coach.careerflow.ai/careerflow/resume/download/e6733d1a-b68f-4056-a011-d138f9392c5f" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Run AI optimization on an existing resume against a specific job description. Pass the resume ID and job ID in the request body. Returns the optimized resume content." } }, "/jobTracker/v2/resumes": { "post": { "tags": [ "Resume Builder" ], "summary": "Create Resume", "operationId": "post_create_resume_from_scratch", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "resumeTitle": { "type": "string" }, "resumeSectionFields": { "type": "object", "properties": { "basics": { "type": "object", "properties": { "rawName": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "fname": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "lname": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "headline": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "email": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "phone": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "postalCode": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "openToRemote": { "type": "boolean" }, "openToRelocate": { "type": "boolean" }, "openToHybrid": { "type": "boolean" }, "openToTravel": { "type": "boolean" }, "openToOnSite": { "type": "boolean" }, "openTo": { "type": "array", "items": { "type": "string" } }, "address": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "dob": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "gender": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "nationality": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "targetJobTitle": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "label": { "type": "string" }, "href": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "label", "href", "visible" ] }, "customFields": { "type": "array", "items": { "type": "string" } }, "picture": { "type": "object", "properties": { "url": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "size": { "type": "integer" }, "aspectRatio": { "type": "integer" }, "borderRadius": { "type": "integer" }, "effects": { "type": "object", "properties": { "hidden": { "type": "boolean" }, "border": { "type": "boolean" }, "grayscale": { "type": "boolean" } }, "required": [ "hidden", "border", "grayscale" ] } }, "required": [ "url", "size", "aspectRatio", "borderRadius", "effects" ] } }, "required": [ "rawName", "fname", "lname", "headline", "email", "phone", "location", "postalCode", "openToRemote", "openToRelocate", "openToHybrid", "openToTravel", "openToOnSite", "openTo", "address", "dob", "gender", "nationality", "country", "state", "city", "targetJobTitle", "url", "customFields", "picture" ] }, "sections": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } } }, "required": [ "name", "visible", "id", "items" ] }, "awards": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "title": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "awarder": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "date", "visible", "summary", "url", "title", "awarder" ] } } }, "required": [ "name", "visible", "id", "items" ] }, "certifications": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "visible", "id", "items" ] }, "education": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "endDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "description": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "studyType": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startMonth": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "area": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "currentlyStudyHere": { "type": "string" }, "endYear": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "institution": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "score": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "endDate", "visible", "description", "summary", "url", "studyType", "startMonth", "city", "area", "startYear", "date", "country", "currentlyStudyHere", "endYear", "institution", "score", "state", "location", "startDate", "endMonth" ] } } }, "required": [ "name", "visible", "id", "items" ] }, "experience": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "endDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "description": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "currentlyWorkHere": { "type": "boolean" }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "company": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "position": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "endDate", "visible", "description", "summary", "url", "currentlyWorkHere", "city", "startMonth", "startYear", "company", "date", "country", "endYear", "position", "state", "location", "startDate", "endMonth" ] } } }, "required": [ "name", "visible", "id", "items" ] }, "volunteering": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "visible", "id", "items" ] }, "interests": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "visible", "id", "items" ] }, "languages": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "visible", "id", "items" ] }, "profiles": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "visible": { "type": "boolean" }, "network": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "username": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "icon": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "label": { "type": "string" }, "href": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "label", "href", "visible" ] } }, "required": [ "id", "visible", "network", "username", "icon", "url" ] } } }, "required": [ "name", "visible", "id", "items" ] }, "projects": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "visible", "id", "items" ] }, "publications": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "visible", "id", "items" ] }, "references": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "visible", "id", "items" ] }, "skills": { "type": "object", "properties": { "name": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "visible", "id", "items" ] }, "custom": { "type": "array", "items": { "type": "string" } } }, "required": [ "summary", "awards", "certifications", "education", "experience", "volunteering", "interests", "languages", "profiles", "projects", "publications", "references", "skills", "custom" ] }, "metadata": { "type": "object", "properties": { "layout": { "type": "array", "items": { "type": "object", "properties": { "sectionTitle": { "type": "string" }, "sectionName": { "type": "string" } }, "required": [ "sectionTitle", "sectionName" ] } } }, "required": [ "layout" ] }, "template": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "name", "version" ] }, "createdBy": { "type": "string" }, "createdUserRole": { "type": "string" } }, "required": [ "basics", "sections", "metadata", "template", "createdBy", "createdUserRole" ] } }, "required": [ "resumeTitle", "resumeSectionFields" ] }, "example": { "resumeTitle": "Example Resume with Filled Data Testing", "resumeSectionFields": { "basics": { "rawName": { "text": "Jane Doe", "visible": true }, "fname": { "text": "Jane", "visible": true }, "lname": { "text": "Doe", "visible": true }, "headline": { "text": "", "visible": false }, "email": { "text": "example@email.com", "visible": true }, "phone": { "text": "1234567890", "visible": true }, "location": { "text": "United States", "visible": true }, "postalCode": { "text": "", "visible": false }, "openToRemote": false, "openToRelocate": true, "openToHybrid": false, "openToTravel": false, "openToOnSite": false, "openTo": [ "openToRemote", "openToRelocate" ], "address": { "text": "", "visible": true }, "dob": { "text": "", "visible": false }, "gender": { "text": "", "visible": false }, "nationality": { "text": "", "visible": false }, "country": { "text": "United States", "visible": true }, "state": { "text": "", "visible": true }, "city": { "text": "", "visible": true }, "targetJobTitle": { "text": "", "visible": true }, "url": { "label": "", "href": "", "visible": false }, "customFields": [], "picture": { "url": { "text": "", "visible": true }, "size": 64, "aspectRatio": 1, "borderRadius": 0, "effects": { "hidden": false, "border": false, "grayscale": false } } }, "sections": { "summary": { "name": "Summary", "visible": true, "id": "summary", "items": [ { "text": "Sample Summary of this resume. Use AI to enhance it!", "visible": true } ] }, "awards": { "name": "Awards", "visible": true, "id": "awards", "items": [ { "date": { "text": "2025-05-03T07:00:00.000Z", "visible": true }, "visible": true, "summary": { "text": "Won Best AR/VR Hack at PennApps Hackathon and Winner of 10 other hackathons", "visible": true }, "url": { "text": "", "visible": true }, "title": { "text": "Hackathon Winner", "visible": true }, "awarder": { "text": "Multiple Hackathons", "visible": true } } ] }, "certifications": { "name": "Certifications", "visible": true, "id": "certifications", "items": [] }, "education": { "name": "Education", "visible": true, "id": "education", "items": [ { "endDate": { "text": "", "visible": false }, "visible": true, "description": [], "summary": { "text": "I took courses like Course A, Course B, and Course C.", "visible": true }, "url": { "href": "", "visible": false, "label": "" }, "studyType": { "text": "Communication", "visible": true }, "startMonth": { "text": "", "visible": true }, "city": { "text": "", "visible": true }, "area": { "text": "Bachelor of Arts", "visible": true }, "startYear": { "text": "", "visible": true }, "date": { "text": "", "visible": true }, "country": { "text": "United States", "visible": true }, "currentlyStudyHere": "", "endYear": { "text": "", "visible": false }, "institution": { "text": "Example University", "visible": true }, "score": { "text": "4.0/4.0", "visible": true }, "state": { "text": "", "visible": true }, "location": { "text": "", "visible": true }, "startDate": { "text": "", "visible": true }, "endMonth": { "text": "", "visible": true } } ] }, "experience": { "name": "Experience", "visible": true, "id": "experience", "items": [ { "endDate": { "text": "2023-12-31", "visible": false }, "visible": true, "description": [ { "text": "Responsible for End-to-end computer vision projects, prototyping, and pipelines for computer vision tasks involving object detection, semantic segmentation, and classification. (Python, OpenCV, PyTorch, Dataset curation).", "visible": true }, { "text": "Implemented secure authentication protocols in computer vision applications, enhancing data protection and access control for sensitive image processing tasks.", "visible": true } ], "summary": { "text": "", "visible": true }, "url": { "href": "", "visible": true, "label": "" }, "currentlyWorkHere": true, "city": { "text": "", "visible": true }, "startMonth": { "text": 4, "visible": true }, "startYear": { "text": 2020, "visible": true }, "company": { "text": "Example Company A", "visible": true }, "date": { "text": "2020-04-01 - 2023-12-31", "visible": true }, "country": { "text": "United States", "visible": true }, "endYear": { "text": 2023, "visible": true }, "position": { "text": "Example Fulltime Role", "visible": true }, "state": { "text": "", "visible": true }, "location": { "text": "", "visible": false }, "startDate": { "text": "2020-04-01", "visible": false }, "endMonth": { "text": 12, "visible": true } }, { "endDate": { "text": "2020-04-01", "visible": false }, "visible": true, "description": [ { "text": "Developed libraries for real-time stereo disparity estimation, multi-camera calibration, etc (C++, GLSL, Java, OpenCV) and optimized for real-time performance on mobile GPUs.", "visible": true }, { "text": "Building and deploying Neural Networks (CNNs) for a variety of 3D Computer Vision tasks (PyTorch, Python).", "visible": true } ], "summary": { "text": "", "visible": false }, "url": { "href": "", "visible": false, "label": "" }, "currentlyWorkHere": false, "city": { "text": "", "visible": true }, "startMonth": { "text": 9, "visible": true }, "startYear": { "text": 2018, "visible": true }, "company": { "text": "Example Company B", "visible": true }, "date": { "text": "2018-09-01 - 2020-04-01", "visible": false }, "country": { "text": "", "visible": false }, "endYear": { "text": 2020, "visible": true }, "position": { "text": "Sample Internship", "visible": true }, "state": { "text": "", "visible": true }, "location": { "text": "", "visible": false }, "startDate": { "text": "2018-09-01", "visible": false }, "endMonth": { "text": 4, "visible": true } } ] }, "volunteering": { "name": "Volunteering", "visible": true, "id": "volunteering", "items": [] }, "interests": { "name": "Interests", "visible": false, "id": "interests", "items": [] }, "languages": { "name": "Languages", "visible": false, "id": "languages", "items": [] }, "profiles": { "name": "Profiles", "visible": true, "id": "profiles", "items": [ { "id": "1", "visible": true, "network": { "text": "LinkedIn Profile", "visible": true }, "username": { "text": "", "visible": false }, "icon": { "text": "", "visible": false }, "url": { "label": "LinkedIn", "href": "https://www.linkedin.com/in/sanuj-bansal/", "visible": false } } ] }, "projects": { "name": "Projects", "visible": true, "id": "projects", "items": [] }, "publications": { "name": "Publications", "visible": true, "id": "publications", "items": [] }, "references": { "name": "References", "visible": true, "id": "references", "items": [] }, "skills": { "name": "Skills", "visible": true, "id": "skills", "items": [] }, "custom": [] }, "metadata": { "layout": [ { "sectionTitle": "Personal Information", "sectionName": "PERSONAL_INFORMATION" }, { "sectionTitle": "Website & Social Links", "sectionName": "profiles" } ] }, "template": { "name": "Faangpath", "version": "1" }, "createdBy": "API", "createdUserRole": "COACH" } } } } }, "responses": { "200": { "description": "Create Resume From Scratch", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Create a new resume from scratch. Pass the resume content in the request body. Use `userId` query parameter to specify the student." } }, "/ai-services/v1/resume/prompt-generate": { "post": { "tags": [ "Resume Builder" ], "summary": "Generate Resume with AI Prompt", "operationId": "post_create_resume_with_prompt", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string" }, "generateResumePrompt": { "type": "string" }, "user_type": { "type": "string" }, "config": { "type": "object", "properties": { "open_to_change": { "type": "boolean" } }, "required": [ "open_to_change" ] }, "careerflow_resume": { "type": "object", "properties": { "basics": { "type": "object", "properties": { "rawName": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "fname": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "lname": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "headline": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "email": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "phone": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "postalCode": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "openToRemote": { "type": "boolean" }, "openToRelocate": { "type": "boolean" }, "openToHybrid": { "type": "boolean" }, "openToTravel": { "type": "boolean" }, "openToOnSite": { "type": "boolean" }, "openTo": { "type": "array", "items": { "type": "string" } }, "address": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "dob": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "gender": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "nationality": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "targetJobTitle": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "label": { "type": "string" }, "href": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "label", "href", "visible" ] }, "customFields": { "type": "array", "items": { "type": "string" } }, "picture": { "type": "object", "properties": { "url": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "size": { "type": "integer" }, "aspectRatio": { "type": "integer" }, "borderRadius": { "type": "integer" }, "effects": { "type": "object", "properties": { "hidden": { "type": "boolean" }, "border": { "type": "boolean" }, "grayscale": { "type": "boolean" } }, "required": [ "hidden", "border", "grayscale" ] } }, "required": [ "url", "size", "aspectRatio", "borderRadius", "effects" ] } }, "required": [ "rawName", "fname", "lname", "headline", "email", "phone", "location", "postalCode", "openToRemote", "openToRelocate", "openToHybrid", "openToTravel", "openToOnSite", "openTo", "address", "dob", "gender", "nationality", "country", "state", "city", "targetJobTitle", "url", "customFields", "picture" ] }, "sections": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "awards": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "certifications": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "education": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "experience": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "totalYearsExperience": { "type": "integer" } }, "required": [ "name", "columns", "visible", "id", "items", "totalYearsExperience" ] }, "volunteering": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "interests": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "languages": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "profiles": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "visible": { "type": "boolean" }, "network": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "username": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "icon": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "label": { "type": "string" }, "href": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "label", "href", "visible" ] } }, "required": [ "id", "visible", "network", "username", "icon", "url" ] } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "projects": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "publications": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "references": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "skills": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "visible", "id", "items" ] }, "custom": { "type": "array", "items": { "type": "string" } } }, "required": [ "summary", "awards", "certifications", "education", "experience", "volunteering", "interests", "languages", "profiles", "projects", "publications", "references", "skills", "custom" ] }, "metadata": { "type": "object", "properties": { "template": { "type": "string" }, "layout": { "type": "array", "items": { "type": "object", "properties": { "sectionName": { "type": "string" } }, "required": [ "sectionName" ] } }, "css": { "type": "object", "properties": { "value": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "value", "visible" ] }, "page": { "type": "object", "properties": { "margin": { "type": "integer" }, "format": { "type": "string" }, "options": { "type": "object", "properties": { "breakLine": { "type": "boolean" }, "pageNumbers": { "type": "boolean" } }, "required": [ "breakLine", "pageNumbers" ] } }, "required": [ "margin", "format", "options" ] }, "theme": { "type": "object", "properties": { "background": { "type": "string" }, "text": { "type": "string" }, "primary": { "type": "string" } }, "required": [ "background", "text", "primary" ] }, "typography": { "type": "object", "properties": { "font": { "type": "object", "properties": { "family": { "type": "string" }, "subset": { "type": "string" }, "variants": { "type": "array", "items": { "type": "string" } }, "size": { "type": "integer" } }, "required": [ "family", "subset", "variants", "size" ] }, "lineHeight": { "type": "number" }, "hideIcons": { "type": "boolean" }, "underlineLinks": { "type": "boolean" } }, "required": [ "font", "lineHeight", "hideIcons", "underlineLinks" ] }, "notes": { "type": "string" } }, "required": [ "template", "layout", "css", "page", "theme", "typography", "notes" ] } }, "required": [ "basics", "sections", "metadata" ] }, "template": { "type": "string" }, "isBase": { "type": "boolean" } }, "required": [ "user_id", "generateResumePrompt", "user_type", "config", "careerflow_resume", "template", "isBase" ] }, "example": { "user_id": "5r6tHsHulkfnwDAH2Gae9UdmcPd2", "generateResumePrompt": "Create a resume for a student studying at Ultimate Medical Academy who took course SS200 and has an internship experience as well.", "user_type": "USER", "config": { "open_to_change": false }, "careerflow_resume": { "basics": { "rawName": { "text": "Jane Doe", "visible": true }, "fname": { "text": "Jane", "visible": true }, "lname": { "text": "Doe", "visible": true }, "headline": { "text": "", "visible": false }, "email": { "text": "email@example.com", "visible": true }, "phone": { "text": "", "visible": true }, "location": { "text": "United States", "visible": true }, "postalCode": { "text": "", "visible": false }, "openToRemote": false, "openToRelocate": false, "openToHybrid": false, "openToTravel": false, "openToOnSite": false, "openTo": [ "openToRemote", "openToRelocate" ], "address": { "text": "", "visible": true }, "dob": { "text": "", "visible": false }, "gender": { "text": "", "visible": false }, "nationality": { "text": "", "visible": false }, "country": { "text": "United States", "visible": true }, "state": { "text": "", "visible": true }, "city": { "text": "", "visible": true }, "targetJobTitle": { "text": "", "visible": true }, "url": { "label": "", "href": "", "visible": false }, "customFields": [], "picture": { "url": { "text": "", "visible": true }, "size": 64, "aspectRatio": 1, "borderRadius": 0, "effects": { "hidden": false, "border": false, "grayscale": false } } }, "sections": { "summary": { "name": "Summary", "columns": 1, "visible": true, "id": "summary", "items": [] }, "awards": { "name": "Awards", "columns": 1, "visible": true, "id": "awards", "items": [] }, "certifications": { "name": "Certifications", "columns": 1, "visible": true, "id": "certifications", "items": [] }, "education": { "name": "Education", "columns": 1, "visible": true, "id": "education", "items": [] }, "experience": { "name": "Experience", "columns": 1, "visible": true, "id": "experience", "items": [], "totalYearsExperience": 0 }, "volunteering": { "name": "Volunteering", "columns": 1, "visible": true, "id": "volunteering", "items": [] }, "interests": { "name": "Interests", "columns": 1, "visible": false, "id": "interests", "items": [] }, "languages": { "name": "Languages", "columns": 1, "visible": false, "id": "languages", "items": [] }, "profiles": { "name": "Profiles", "columns": 1, "visible": true, "id": "profiles", "items": [ { "id": "1", "visible": true, "network": { "text": "LinkedIn Profile", "visible": true }, "username": { "text": "", "visible": false }, "icon": { "text": "", "visible": false }, "url": { "label": "LinkedIn", "href": "https://www.linkedin.com/in/sanuj-bansal/", "visible": false } } ] }, "projects": { "name": "Projects", "columns": 1, "visible": true, "id": "projects", "items": [] }, "publications": { "name": "Publications", "columns": 1, "visible": true, "id": "publications", "items": [] }, "references": { "name": "References", "columns": 1, "visible": true, "id": "references", "items": [] }, "skills": { "name": "Skills", "columns": 1, "visible": true, "id": "skills", "items": [] }, "custom": [] }, "metadata": { "template": "Faangpath", "layout": [ { "sectionName": "summary" }, { "sectionName": "experience" } ], "css": { "value": ".section {\n\toutline: 1px solid #000;\n\toutline-offset: 4px;\n}", "visible": false }, "page": { "margin": 18, "format": "a4", "options": { "breakLine": true, "pageNumbers": true } }, "theme": { "background": "#ffffff", "text": "#000000", "primary": "#dc2626" }, "typography": { "font": { "family": "IBM Plex Serif", "subset": "latin", "variants": [ "regular", "italic" ], "size": 14 }, "lineHeight": 1.5, "hideIcons": false, "underlineLinks": true }, "notes": "" } }, "template": "Faangpath", "isBase": true } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate a complete resume using an AI prompt. Provide a text prompt describing the desired resume and the AI will generate structured resume content." } }, "/jobTracker/v2/resumes/filter": { "post": { "tags": [ "Resume Builder" ], "summary": "List Resumes", "operationId": "post_get_resumes", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "last": { "type": "string" }, "sort": { "type": "object", "properties": { "field": { "type": "string" }, "order": { "type": "string" } }, "required": [ "field", "order" ] }, "search": { "type": "string" }, "pageSize": { "type": "integer" }, "filters": { "type": "object", "properties": {} } }, "required": [ "last", "sort", "search", "pageSize", "filters" ] }, "example": { "last": null, "sort": { "field": "createdAt", "order": "desc" }, "search": "", "pageSize": 50, "filters": {} } } } }, "responses": { "200": { "description": "sample response", "content": { "application/json": { "schema": { "type": "object", "properties": { "resumeId": { "type": "string" } }, "required": [ "resumeId" ] }, "example": { "resumeId": "GvInmhnCTsOQWNVdDdiu" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve resumes for a student with optional filtering. Pass `userId` as a query parameter to specify the student." } }, "/jobTracker/v2/resumes/{resumeId}": { "get": { "tags": [ "Resume Builder" ], "summary": "Get Resume by ID", "operationId": "get_get_resume_by_resume_id_and_user_id", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "resumeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The resumeId identifier." }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "responses": { "200": { "description": "sample response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rawText": { "type": "string" }, "summarizedText": { "type": "string" }, "resumeScore": { "type": "integer" }, "resumeTitle": { "type": "string" }, "status": { "type": "string" }, "generateSource": { "type": "object", "properties": { "sourceId": { "type": "string" }, "type": { "type": "string" } }, "required": [ "sourceId", "type" ] }, "resumeAnalysis": { "type": "array", "items": { "type": "object", "properties": { "item": { "type": "string" }, "priority": { "type": "string" }, "section": { "type": "string" }, "positiveText": { "type": "string" }, "negativeText": { "type": "string" }, "reasonText": { "type": "string" }, "recommendationText": { "type": "string" }, "positiveTitle": { "type": "string" }, "negativeTitle": { "type": "string" }, "completed": { "type": "boolean" }, "field": { "type": "string" } }, "required": [ "item", "priority", "section", "positiveText", "negativeText", "reasonText", "recommendationText", "positiveTitle", "negativeTitle", "completed", "field" ] } }, "resumeSectionFields": { "type": "object", "properties": { "basics": { "type": "object", "properties": { "country": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "gender": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "city": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "customFields": { "type": "array", "items": { "type": "string" } }, "postalCode": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "lname": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "openToRemote": { "type": "boolean" }, "state": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "headline": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "email": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "openToHybrid": { "type": "boolean" }, "fname": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "openToRelocate": { "type": "boolean" }, "address": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "openTo": { "type": "array", "items": { "type": "string" } }, "openToTravel": { "type": "boolean" }, "rawName": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "picture": { "type": "object", "properties": { "effects": { "type": "object", "properties": { "border": { "type": "boolean" }, "hidden": { "type": "boolean" }, "grayscale": { "type": "boolean" } }, "required": [ "border", "hidden", "grayscale" ] }, "borderRadius": { "type": "integer" }, "size": { "type": "integer" }, "aspectRatio": { "type": "integer" }, "url": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] } }, "required": [ "effects", "borderRadius", "size", "aspectRatio", "url" ] }, "url": { "type": "object", "properties": { "visible": { "type": "boolean" }, "href": { "type": "string" }, "label": { "type": "string" } }, "required": [ "visible", "href", "label" ] }, "nationality": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "phone": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "dob": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "location": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "openToOnSite": { "type": "boolean" }, "targetJobTitle": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] } }, "required": [ "country", "gender", "city", "customFields", "postalCode", "lname", "openToRemote", "state", "headline", "email", "openToHybrid", "fname", "openToRelocate", "address", "openTo", "openToTravel", "rawName", "picture", "url", "nationality", "phone", "dob", "location", "openToOnSite", "targetJobTitle" ] }, "metadata": { "type": "object", "properties": { "layout": { "type": "array", "items": { "type": "object", "properties": { "sectionName": { "type": "string" }, "sectionTitle": { "type": "string" } }, "required": [ "sectionName", "sectionTitle" ] } }, "template": { "type": "string" }, "typography": { "type": "object", "properties": { "underlineLinks": { "type": "boolean" }, "lineHeight": { "type": "number" }, "hideIcons": { "type": "boolean" }, "font": { "type": "object", "properties": { "size": { "type": "integer" }, "variants": { "type": "array", "items": { "type": "string" } }, "family": { "type": "string" }, "subset": { "type": "string" } }, "required": [ "size", "variants", "family", "subset" ] } }, "required": [ "underlineLinks", "lineHeight", "hideIcons", "font" ] }, "css": { "type": "object", "properties": { "visible": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "visible", "value" ] }, "notes": { "type": "string" }, "theme": { "type": "object", "properties": { "background": { "type": "string" }, "text": { "type": "string" }, "primary": { "type": "string" } }, "required": [ "background", "text", "primary" ] }, "page": { "type": "object", "properties": { "margin": { "type": "integer" }, "format": { "type": "string" }, "options": { "type": "object", "properties": { "pageNumbers": { "type": "boolean" }, "breakLine": { "type": "boolean" } }, "required": [ "pageNumbers", "breakLine" ] } }, "required": [ "margin", "format", "options" ] } }, "required": [ "layout", "template", "typography", "css", "notes", "theme", "page" ] }, "sections": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "id", "visible", "text" ] } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "education": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "visible": { "type": "boolean" }, "institution": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "studyType": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "area": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "score": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "currentlyStudyHere": { "type": "boolean" }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "description": { "type": "array", "items": { "type": "string" } }, "url": { "type": "object", "properties": { "label": { "type": "string" }, "href": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "label", "href", "visible" ] }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "id", "visible", "institution", "studyType", "area", "score", "date", "summary", "location", "startMonth", "startYear", "endMonth", "endYear", "startDate", "endDate", "currentlyStudyHere", "city", "country", "description", "url", "state" ] } }, "isCustomSectionTitleName": { "type": "boolean" } }, "required": [ "visible", "columns", "name", "id", "items", "isCustomSectionTitleName" ] }, "projects": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "languages": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "visible": { "type": "boolean" }, "name": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "description": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } } }, "required": [ "id", "visible", "name", "description" ] } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "references": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "custom": { "type": "array", "items": { "type": "string" } }, "profiles": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "visible": { "type": "boolean" }, "network": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "username": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "icon": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "label": { "type": "string" }, "href": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "label", "href", "visible" ] } }, "required": [ "id", "visible", "network", "username", "icon", "url" ] } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "certifications": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "experience": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "totalYearsExperience": { "type": "integer" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "visible": { "type": "boolean" }, "company": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "position": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "currentlyWorkHere": { "type": "boolean" }, "remotePosition": { "type": "boolean" }, "url": { "type": "object", "properties": { "label": { "type": "string" }, "href": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "label", "href", "visible" ] }, "description": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" } }, "required": [ "text", "visible", "id" ] } }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "id", "visible", "company", "position", "location", "startMonth", "startYear", "endMonth", "endYear", "summary", "currentlyWorkHere", "remotePosition", "url", "description", "city", "country", "state", "startDate", "endDate", "date" ] } }, "isCustomSectionTitleName": { "type": "boolean" } }, "required": [ "visible", "columns", "name", "totalYearsExperience", "id", "items", "isCustomSectionTitleName" ] }, "skills": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "visible": { "type": "boolean" }, "description": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "category": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "skills": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "level": { "type": "integer" }, "keywords": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "visible", "description", "category", "skills", "level", "keywords" ] } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "awards": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "volunteering": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "interests": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "publications": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] } }, "required": [ "summary", "education", "projects", "languages", "references", "custom", "profiles", "certifications", "experience", "skills", "awards", "volunteering", "interests", "publications" ] } }, "required": [ "basics", "metadata", "sections" ] }, "template": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "name", "version" ] }, "createdBy": { "type": "string" }, "createdUserRole": { "type": "string" }, "isBase": { "type": "boolean" }, "createdAt": { "type": "integer" }, "updatedAt": { "type": "integer" }, "id": { "type": "string" }, "documentId": { "type": "string" } }, "required": [ "rawText", "summarizedText", "resumeScore", "resumeTitle", "status", "generateSource", "resumeAnalysis", "resumeSectionFields", "template", "createdBy", "createdUserRole", "isBase", "createdAt", "updatedAt", "id", "documentId" ] }, "example": { "rawText": "India New Delhi Jain Delhi Senior software Engineer morgan.taylor@example.com Rishabh RISHABH JAIN +1-555-0100 New Delhi, DL, India Testing
Engineering Manager with 10+ years of experience in backend development, focused on Fintech and US payment systems (Cards, ACH, Checks, MRDC).
Leading high-performing engineering teams at Gokwik to build scalable, reliable, and efficient systems.
Expert in Node.
js, MySQL, NestJS, Express, React, and Redux.
Strong background in system design, performance optimization, and scaling backend architectures.
Hands-on with APM tools like Dynatrace and AppDynamics for monitoring and profiling.
Passionate about clean code, best practices, and long-term maintainability.
Skilled communicator who bridges technical and business needs effectively.
Active in the tech community through blogs and continuous learning.
Maharaja Surajmal Institute of Technology Bachelor Electronics and Communication Jun '10 — Jun '14

Delhi, India 6 2010 6 2014 2010-06-01 2014-06-01 India Delhi English LinkedIn Profile GoKwik Engineering Manager 2 2025 4 2025 Led a team of 12 engineers at KwikChat, fostering a collaborative environment that increased project delivery speed by 25%. Improved engineering processes by streamlining workflows and implementing efficient project management techniques. Identified areas of improvement in existing systems, providing recommendations that resulted in significant cost savings over time. Fostered a culture of innovation and continuous improvement by encouraging the sharing of ideas, leading to increased creativity and problem-solving capabilities within the team. Gurugram India Haryana 2025-02-01 2025-04-01 2025-02-01 - 2025-04-01 NOVO Engineer Manager 9 2021 2 2025 Lead a dynamic team of 15 professionals in designing and implementing innovative financial solutions. My role encompasses the full product lifecycle—from gathering requirements and architectural design to coding and delivering market-ready solutions. Planned and Implemented Banking and Card Solutions from Scratch. Built multiple teams from scratch Banking, Cards and Ecosystem. Wrote, reviewed and edited technical document in accordance with template requirements. Enhanced product performance by conducting thorough failure analysis and recommending improvements. Led cross-functional teams to innovate on product design, enhancing user experience and functionality. Enhanced team performance by implementing structured onboarding program for new engineers, reducing ramp-up time. Gurugram India Haryana 2021-09-01 2025-02-01 2021-09-01 - 2025-02-01 C2FO Senior Software Engineer 9 2020 9 2021 Led the implementation of a 'Pay Later' prototype, successfully onboarding multiple clients for beta testing, providing valuable insights for product refinement. Managed a team of 7 professionals, facilitating scrum activities and fostering a collaborative environment to drive project success. Enhanced software functionality by identifying and resolving complex technical issues. Managed multiple projects simultaneously while maintaining strict deadlines and high-quality standards. Noida India Uttar Pradesh 2020-09-01 2021-09-01 2020-09-01 - 2021-09-01 Paytmall (Infogain) Senior Software Engineer 5 2018 3 2019 Developed and Designed Localization service Helped teams with the integration of localization service with Paytm and Paytm Mall Apps Helped the Scaling of localization service with message queues like RabbitMQ and Caching techniques with Redis Coordinated with product owner for successful development of service Translated technical concepts and information into terms parties could easily comprehend. Created proofs of concept for innovative new solutions. 2018-05-01 2019-03-01 2018-05-01 - 2019-03-01 Gspann Senior Software Engineer 11 2019 9 2020 Implemented Inventory Management system for Kohl's client. Requirement Gathering by analyzing Legacy Application Lead team of 8 members Developed scalable applications using agile methodologies for timely project delivery. Analyzed proposed technical solutions based on customer requirements. 2019-11-01 2020-09-01 2019-11-01 - 2020-09-01 THE New Senior Software Engineer 3 2019 11 2019 Extending the existing Google Docs extension with new features of subscriptions Development of Google presentation extension with feedback system with support of shapes, text, images, videos and audio Implemented Audio recording with the Kaizena website with the help of HTML5 Media Recorder Mentored junior developers, fostering professional growth and enhancing team productivity. Enhanced software functionality by identifying and resolving complex technical issues. 2019-03-01 2019-11-01 2019-03-01 - 2019-11-01 Cognizant Associate Software Engineer 12 2014 5 2018 Development of Work Order Management system Worked on planning and designing different modules of application Leading projects for a few major modules Managing performance of applications Scaled systems by making them performance efficient through load testing using NeoLoad and also done end to end performance analysis. Expertise in debugging and solving performance issues in application by analyzing threads, memory, GC logs. Tested and deployed scalable and highly available software products. 2014-12-01 2018-05-01 2014-12-01 - 2018-05-01 Database Management MySQL PostgreSQL Redis Backend Development Node.JS Express.js Nest.JS Message Queuing Kafka RabbitMQ Performance Testing Jprofiler LoadRunner Cloud Services AWS Docker", "summarizedText": "### Key Talking Points for Rishabh Jain's Resume\n\n**Professional Summary:**\n- Engineering Manager with over 10 years of experience in backend development, specializing in Fintech and US payment systems (Cards, ACH, Checks, MRDC).\n- Proven track record in leading high-performing engineering teams to build scalable and efficient systems.\n- Expertise in technologies: Node.js, MySQL, NestJS, Express, React, and Redux.\n- Strong focus on system design, performance optimization, and backend architecture scaling.\n- Proficient in APM tools (Dynatrace, AppDynamics) for monitoring and profiling.\n- Committed to clean code practices and long-term maintainability.\n\n**Key Achievements:**\n1. **Gokwik (Feb '25 - Apr '25)**:\n - Led a team of 12 engineers, increasing project delivery speed by 25%.\n - Streamlined engineering processes, resulting in significant cost savings.\n - Fostered a culture of innovation, enhancing team creativity and problem-solving.\n\n2. **Novo (Sep '21 - Feb '25)**:\n - Managed a team of 15, overseeing the full product lifecycle for innovative financial solutions.\n - Successfully planned and implemented Banking and Card Solutions from scratch.\n - Enhanced product performance through failure analysis and cross-functional team collaboration.\n - Developed a structured onboarding program, reducing new engineer ramp-up time.\n\n3. **C2FO (Sep '20 - Sep '21)**:\n - Led the implementation of a 'Pay Later' prototype, onboarding multiple clients for beta testing.\n - Managed a team of 7, facilitating scrum activities and ensuring project success.\n\n4. **Paytmall (Infogain) (May '18 - Mar '19)**:\n - Developed and designed a Localization service, integrating it with Paytm and Paytm Mall Apps.\n - Scaled the localization service using RabbitMQ and Redis.\n\n5. **Gspann (Nov '19 - Sep '20)**:\n - Implemented an Inventory Management system for Kohl's, leading a team of 8.\n - Delivered scalable applications using agile methodologies.\n\n6. **Cognizant (Dec '14 - May '18)**:\n - Developed a Work Order Management system, leading major modules and enhancing application performance through load testing.\n\n**Skills:**\n- Technical: MySQL, Node.js, Express.js, Kafka, PostgreSQL, RabbitMQ, Redis, Docker.\n- Management: Team Building, Project Management, Team Culture.\n- Tools: Jprofiler, LoadRunner, APM tools.\n\n**Education:**\n- Bachelor of Technology in Electronics and Communication from Maharaja Surajmal Institute of Technology (Jun '10 - Jun '14).\n\n**Interests:**\n- Active in the tech community through blogging and continuous learning. \n\nThis summary encapsulates Rishabh Jain's key achievements, skills, and experiences, making it suitable for a vector search index focused on engineering management roles in the fintech sector.", "resumeScore": 77, "resumeTitle": "Copy of Data Analyst and Model Validation Consultant at Guidehouse", "status": "COMPLETED", "generateSource": { "sourceId": "GXSncMEwK6R4Dr38lJix", "type": "Duplicate" }, "resumeAnalysis": [ { "item": "namePresent", "priority": "IMPORTANT", "section": "PERSONAL_INFORMATION", "positiveText": "Great! You have added your first and last name", "negativeText": "Please add your first and last name to your resume for better accessibility", "reasonText": "Adding your first and last name to your resume can help recruiters differentiate you from other applicants.", "recommendationText": "Add your first and last name on your resume.", "positiveTitle": "Name Present", "negativeTitle": "Name Missing", "completed": true, "field": "fname" }, { "item": "emailPresent", "priority": "IMPORTANT", "section": "PERSONAL_INFORMATION", "positiveText": "Fantastic job! You've successfully added your Email. Just wait and see – a lot of interview requests will come into your inbox shortly!", "negativeText": "Please add your email ID so that recruiters can reach out to you.", "reasonText": "It is important to include your Email ID, as 75% of resumes with unprofessional email addresses get rejected.", "recommendationText": "The Email ID in your resume should not belong to any company or institute.", "positiveTitle": "Email Present", "negativeTitle": "Email Missing", "completed": true, "field": "email" } ], "resumeSectionFields": { "basics": { "country": { "visible": true, "text": "India" }, "gender": { "visible": false, "text": "" }, "city": { "visible": true, "text": "New Delhi" }, "customFields": [], "postalCode": { "visible": true, "text": "" }, "lname": { "visible": true, "text": "Jain" }, "openToRemote": false, "state": { "visible": true, "text": "Delhi" }, "headline": { "visible": true, "text": "Senior software Engineer" }, "email": { "visible": true, "text": "morgan.taylor@example.com" }, "openToHybrid": false, "fname": { "visible": true, "text": "Rishabh" }, "openToRelocate": false, "address": { "visible": true, "text": "" }, "openTo": [ "openToRemote", "openToRelocate" ], "openToTravel": false, "rawName": { "visible": true, "text": "RISHABH JAIN" }, "picture": { "effects": { "border": false, "hidden": false, "grayscale": false }, "borderRadius": 0, "size": 64, "aspectRatio": 1, "url": { "visible": true, "text": "" } }, "url": { "visible": false, "href": "", "label": "" }, "nationality": { "visible": false, "text": "" }, "phone": { "visible": true, "text": "+1-555-0100" }, "dob": { "visible": false, "text": "" }, "location": { "visible": true, "text": "New Delhi, DL, India" }, "openToOnSite": false, "targetJobTitle": { "visible": true, "text": "Testing" } }, "metadata": { "layout": [ { "sectionName": "PERSONAL_INFORMATION", "sectionTitle": "Personal Information" }, { "sectionName": "profiles", "sectionTitle": "Website & Social Links" } ], "template": "Faangpath", "typography": { "underlineLinks": true, "lineHeight": 1.5, "hideIcons": false, "font": { "size": 14, "variants": [ "regular", "italic" ], "family": "IBM Plex Serif", "subset": "latin" } }, "css": { "visible": false, "value": ".section {\n\toutline: 1px solid #000;\n\toutline-offset: 4px;\n}" }, "notes": "", "theme": { "background": "#ffffff", "text": "#000000", "primary": "#dc2626" }, "page": { "margin": 18, "format": "a4", "options": { "pageNumbers": true, "breakLine": true } } }, "sections": { "summary": { "visible": true, "columns": 1, "name": "Summary", "id": "summary", "items": [ { "id": "990c767b-ccb5-47bf-8ddc-5ea039b1a4bd", "visible": true, "text": "
Engineering Manager with 10+ years of experience in backend development, focused on Fintech and US payment systems (Cards, ACH, Checks, MRDC).
Leading high-performing engineering teams at Gokwik to build scalable, reliable, and efficient systems.
Expert in Node.
js, MySQL, NestJS, Express, React, and Redux.
Strong background in system design, performance optimization, and scaling backend architectures.
Hands-on with APM tools like Dynatrace and AppDynamics for monitoring and profiling.
Passionate about clean code, best practices, and long-term maintainability.
Skilled communicator who bridges technical and business needs effectively.
Active in the tech community through blogs and continuous learning.
" } ] }, "education": { "visible": true, "columns": 1, "name": "EDUCATION", "id": "education", "items": [ { "id": "3b1d8f4a-297f-449c-9b49-585c1be0ca73", "visible": true, "institution": { "text": "Maharaja Surajmal Institute of Technology", "visible": true }, "studyType": { "text": "Bachelor", "visible": true }, "area": { "text": "Electronics and Communication", "visible": true }, "score": { "text": "", "visible": true }, "date": { "text": "Jun '10 — Jun '14", "visible": true }, "summary": { "text": "

", "visible": true }, "location": { "text": "Delhi, India", "visible": true }, "startMonth": { "text": "6", "visible": true }, "startYear": { "text": 2010, "visible": true }, "endMonth": { "text": "6", "visible": true }, "endYear": { "text": 2014, "visible": true }, "startDate": { "text": "2010-06-01", "visible": true }, "endDate": { "text": "2014-06-01", "visible": true }, "currentlyStudyHere": false, "city": { "text": "", "visible": true }, "country": { "text": "India", "visible": true }, "description": [], "url": { "label": "", "href": "", "visible": false }, "state": { "text": "Delhi", "visible": true } } ], "isCustomSectionTitleName": true }, "projects": { "visible": true, "columns": 1, "name": "Projects", "id": "projects", "items": [] }, "languages": { "visible": false, "columns": 1, "name": "Languages", "id": "languages", "items": [ { "id": "094470bd-f5d3-4128-84e9-9ccfd9c7034b", "visible": true, "name": { "text": "English", "visible": true }, "description": [ { "text": "", "visible": true } ] } ] }, "references": { "visible": true, "columns": 1, "name": "References", "id": "references", "items": [] }, "custom": [], "profiles": { "visible": true, "columns": 1, "name": "Profiles", "id": "profiles", "items": [ { "id": "1", "visible": true, "network": { "text": "LinkedIn Profile", "visible": true }, "username": { "text": "", "visible": false }, "icon": { "text": "", "visible": false }, "url": { "label": "LinkedIn", "href": "https://www.linkedin.com/in/rishabh-jain-a5978583/", "visible": false } } ] }, "certifications": { "visible": true, "columns": 1, "name": "Certifications", "id": "certifications", "items": [] }, "experience": { "visible": true, "columns": 1, "name": "EXPERIENCE", "totalYearsExperience": 10, "id": "experience", "items": [ { "id": "c4e511f2-ba0d-4854-b6f6-56f1cd700cba", "visible": true, "company": { "text": "GoKwik", "visible": true }, "position": { "text": "Engineering Manager", "visible": true }, "location": { "text": "", "visible": true }, "startMonth": { "text": 2, "visible": true }, "startYear": { "text": 2025, "visible": true }, "endMonth": { "text": 4, "visible": true }, "endYear": { "text": 2025, "visible": true }, "summary": { "text": "", "visible": true }, "currentlyWorkHere": false, "remotePosition": false, "url": { "label": "", "href": "", "visible": false }, "description": [ { "text": "Led a team of 12 engineers at KwikChat, fostering a collaborative environment that increased project delivery speed by 25%.", "visible": true, "id": "0d07bd97-a342-4fa3-810c-2d72f9e5450a" }, { "text": "Improved engineering processes by streamlining workflows and implementing efficient project management techniques.", "visible": true, "id": "05edd571-9d4a-47c9-bd90-cd12c4fc9ffd" } ], "city": { "text": "Gurugram", "visible": true }, "country": { "text": "India", "visible": true }, "state": { "text": "Haryana", "visible": true }, "startDate": { "text": "2025-02-01", "visible": true }, "endDate": { "text": "2025-04-01", "visible": true }, "date": { "text": "2025-02-01 - 2025-04-01", "visible": true } }, { "id": "399bd221-f2ea-4428-8fd5-d0d57156f7dc", "visible": true, "company": { "text": "NOVO", "visible": true }, "position": { "text": "Engineer Manager", "visible": true }, "location": { "text": "", "visible": true }, "startMonth": { "text": 9, "visible": true }, "startYear": { "text": 2021, "visible": true }, "endMonth": { "text": 2, "visible": true }, "endYear": { "text": 2025, "visible": true }, "summary": { "text": "", "visible": true }, "currentlyWorkHere": false, "remotePosition": false, "url": { "label": "", "href": "", "visible": false }, "description": [ { "text": "Lead a dynamic team of 15 professionals in designing and implementing innovative financial solutions.", "visible": true, "id": "c0f101b0-bdae-41c0-b72d-d38efb7f9e6d" }, { "text": "My role encompasses the full product lifecycle—from gathering requirements and architectural design to coding and delivering market-ready solutions.", "visible": true, "id": "1e061e33-a00b-4c84-abe7-b064515d1a95" } ], "city": { "text": "Gurugram", "visible": true }, "country": { "text": "India", "visible": true }, "state": { "text": "Haryana", "visible": true }, "startDate": { "text": "2021-09-01", "visible": true }, "endDate": { "text": "2025-02-01", "visible": true }, "date": { "text": "2021-09-01 - 2025-02-01", "visible": true } } ], "isCustomSectionTitleName": true }, "skills": { "visible": true, "columns": 1, "name": "Skills", "id": "skills", "items": [ { "id": "85fcd24e-68e0-4ef4-9801-2fe5b8fe656f", "visible": true, "description": { "text": "", "visible": false }, "category": { "text": "Database Management", "visible": true }, "skills": [ { "text": "MySQL", "visible": true }, { "text": "PostgreSQL", "visible": true } ], "level": 1, "keywords": [] }, { "id": "affae286-477f-4640-a24a-e7fab07f9ae2", "visible": true, "description": { "text": "", "visible": false }, "category": { "text": "Backend Development", "visible": true }, "skills": [ { "text": "Node.JS", "visible": true }, { "text": "Express.js", "visible": true } ], "level": 1, "keywords": [] } ] }, "awards": { "visible": true, "columns": 1, "name": "Awards", "id": "awards", "items": [] }, "volunteering": { "visible": true, "columns": 1, "name": "Volunteering", "id": "volunteering", "items": [] }, "interests": { "visible": false, "columns": 1, "name": "Interests", "id": "interests", "items": [] }, "publications": { "visible": true, "columns": 1, "name": "Publications", "id": "publications", "items": [] } } }, "template": { "name": "Faangpath", "version": "1" }, "createdBy": "5z4lliJytARBeirRT40HHEiT7MC3", "createdUserRole": "USER", "isBase": true, "createdAt": 1750680593348, "updatedAt": 1750680593348, "id": "bVQrSzoEZswuSqtREx5D", "documentId": "vERt99V4jxsfKanAEgSC" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve a specific resume by its ID. Pass `userId` as a query parameter to specify the student." }, "delete": { "tags": [ "Resume Builder" ], "summary": "Delete Resume", "operationId": "delete_delete_resume_by_id", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "resumeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The resumeId identifier." }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Permanently delete a resume by its ID. Pass `userId` as a query parameter to specify the student." } }, "/jobTracker/v2/resumes/clone/{resumeId}": { "post": { "tags": [ "Resume Builder" ], "summary": "Clone Resume", "operationId": "post_clone_resume", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "resumeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The resumeId identifier." }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "responses": { "200": { "description": "sample response", "content": { "application/json": { "schema": { "type": "object", "properties": { "resumeId": { "type": "string" } }, "required": [ "resumeId" ] }, "example": { "resumeId": "GvInmhnCTsOQWNVdDdiu" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Create a duplicate of an existing resume. The cloned resume is created under the same student. Pass `userId` as a query parameter to specify the student." } }, "/jobTracker/v2/resumes/{resumeId}/download": { "get": { "tags": [ "Resume Builder" ], "summary": "Download Resume", "operationId": "get_download_resume_by_id", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "resumeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The resumeId identifier." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Download a resume as a PDF file by its ID." } }, "/jobTracker/v2/resumes/{resumeId}/bulk-update": { "put": { "tags": [ "Resume Builder" ], "summary": "Update Resume", "operationId": "put_update_resume_by_id", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "resumeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The resumeId identifier." }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "jobTitle": { "type": "string" }, "jobDescription": { "type": "string" }, "rawText": { "type": "string" }, "resumeScore": { "type": "integer" }, "resumeAnalysis": { "type": "array", "items": { "type": "object", "properties": { "item": { "type": "string" }, "priority": { "type": "string" }, "section": { "type": "string" }, "positiveText": { "type": "string" }, "negativeText": { "type": "string" }, "reasonText": { "type": "string" }, "recommendationText": { "type": "string" }, "positiveTitle": { "type": "string" }, "negativeTitle": { "type": "string" }, "completed": { "type": "boolean" }, "field": { "type": "string" } }, "required": [ "item", "priority", "section", "positiveText", "negativeText", "reasonText", "recommendationText", "positiveTitle", "negativeTitle", "completed", "field" ] } }, "resumeSkillScore": { "type": "integer" }, "resumeSectionFields": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "template": { "type": "string" }, "typography": { "type": "object", "properties": { "underlineLinks": { "type": "boolean" }, "lineHeight": { "type": "number" }, "hideIcons": { "type": "boolean" }, "font": { "type": "object", "properties": { "size": { "type": "integer" }, "variants": { "type": "array", "items": { "type": "string" } }, "family": { "type": "string" }, "subset": { "type": "string" } }, "required": [ "size", "variants", "family", "subset" ] } }, "required": [ "underlineLinks", "lineHeight", "hideIcons", "font" ] }, "css": { "type": "object", "properties": { "visible": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "visible", "value" ] }, "notes": { "type": "string" }, "theme": { "type": "object", "properties": { "background": { "type": "string" }, "text": { "type": "string" }, "primary": { "type": "string" } }, "required": [ "background", "text", "primary" ] }, "page": { "type": "object", "properties": { "margin": { "type": "integer" }, "format": { "type": "string" }, "options": { "type": "object", "properties": { "pageNumbers": { "type": "boolean" }, "breakLine": { "type": "boolean" } }, "required": [ "pageNumbers", "breakLine" ] } }, "required": [ "margin", "format", "options" ] }, "layout": { "type": "array", "items": { "type": "object", "properties": { "sectionName": { "type": "string" }, "sectionTitle": { "type": "string" } }, "required": [ "sectionName", "sectionTitle" ] } } }, "required": [ "template", "typography", "css", "notes", "theme", "page", "layout" ] }, "sections": { "type": "object", "properties": { "projects": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "visible": { "type": "boolean" }, "name": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "description": { "type": "array", "items": { "type": "string" } }, "startMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "inProgress": { "type": "boolean" }, "url": { "type": "object", "properties": { "label": { "type": "string" }, "visible": { "type": "boolean" }, "href": { "type": "string" } }, "required": [ "label", "visible", "href" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "companyName": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "id", "visible", "name", "description", "startMonth", "endMonth", "startYear", "endYear", "inProgress", "url", "country", "city", "companyName" ] } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "references": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "certifications": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "awards": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "volunteering": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "interests": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "publications": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "summary": { "type": "object", "properties": { "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "visible": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "reason": { "type": "string" }, "isOptimized": { "type": "boolean" }, "beforeText": { "type": "string" }, "afterText": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } } }, "required": [ "text", "visible", "id", "reason", "isOptimized", "beforeText", "afterText", "path" ] } } }, "required": [ "columns", "name", "id", "visible", "items" ] }, "skills": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "category": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "keywords": { "type": "array", "items": { "type": "string" } }, "level": { "type": "integer" }, "skills": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "path": { "type": "array", "items": { "type": "string" } } }, "required": [ "text", "visible", "path" ] } } }, "required": [ "description", "visible", "id", "category", "keywords", "level", "skills" ] } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "education": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "isCustomSectionTitleName": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "endDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "visible": { "type": "boolean" }, "description": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "beforeText": { "type": "string" }, "afterText": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } } }, "required": [ "text", "visible", "beforeText", "afterText", "path" ] }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "studyType": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "area": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "institution": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "currentlyStudyHere": { "type": "boolean" }, "score": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "endDate", "visible", "description", "id", "summary", "url", "studyType", "startMonth", "city", "area", "startYear", "date", "country", "institution", "endYear", "currentlyStudyHere", "score", "state", "location", "startDate", "endMonth" ] } } }, "required": [ "visible", "columns", "name", "id", "isCustomSectionTitleName", "items" ] }, "languages": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "beforeText": { "type": "string" }, "afterText": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } } }, "required": [ "text", "visible", "beforeText", "afterText", "path" ] } }, "required": [ "description", "visible", "id", "name" ] } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "custom": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "integer" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "visible": { "type": "boolean" }, "description": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "id", "visible", "description", "summary" ] } } }, "required": [ "name", "columns", "visible", "id", "items" ] } }, "profiles": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "visible": { "type": "boolean" }, "icon": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "id": { "type": "integer" }, "network": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "beforeText": { "type": "string" }, "afterText": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } } }, "required": [ "text", "visible", "beforeText", "afterText", "path" ] }, "username": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "url", "visible", "icon", "id", "network", "username" ] } } }, "required": [ "visible", "columns", "name", "id", "items" ] }, "experience": { "type": "object", "properties": { "visible": { "type": "boolean" }, "columns": { "type": "integer" }, "name": { "type": "string" }, "totalYearsExperience": { "type": "integer" }, "id": { "type": "string" }, "isCustomSectionTitleName": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" }, "id": { "type": "string" }, "reason": { "type": "string" }, "isOptimized": { "type": "boolean" }, "beforeText": { "type": "string" }, "afterText": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } } }, "required": [ "text", "visible", "id", "reason", "isOptimized", "beforeText", "afterText", "path" ] } }, "visible": { "type": "boolean" }, "endDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "id": { "type": "string" }, "summary": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "url": { "type": "object", "properties": { "href": { "type": "string" }, "visible": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "href", "visible", "label" ] }, "currentlyWorkHere": { "type": "boolean" }, "startMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "city": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "company": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "date": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "country": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endYear": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "position": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "remotePosition": { "type": "boolean" }, "state": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "location": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "startDate": { "type": "object", "properties": { "text": { "type": "string" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] }, "endMonth": { "type": "object", "properties": { "text": { "type": "integer" }, "visible": { "type": "boolean" } }, "required": [ "text", "visible" ] } }, "required": [ "description", "visible", "endDate", "id", "summary", "url", "currentlyWorkHere", "startMonth", "city", "startYear", "company", "date", "country", "endYear", "position", "remotePosition", "state", "location", "startDate", "endMonth" ] } } }, "required": [ "visible", "columns", "name", "totalYearsExperience", "id", "isCustomSectionTitleName", "items" ] } }, "required": [ "projects", "references", "certifications", "awards", "volunteering", "interests", "publications", "summary", "skills", "education", "languages", "custom", "profiles", "experience" ] }, "basics": { "type": "object", "properties": { "gender": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "customFields": { "type": "array", "items": { "type": "string" } }, "postalCode": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "openToRemote": { "type": "boolean" }, "openToHybrid": { "type": "boolean" }, "address": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "openTo": { "type": "array", "items": { "type": "string" } }, "openToTravel": { "type": "boolean" }, "picture": { "type": "object", "properties": { "effects": { "type": "object", "properties": { "border": { "type": "boolean" }, "hidden": { "type": "boolean" }, "grayscale": { "type": "boolean" } }, "required": [ "border", "hidden", "grayscale" ] }, "borderRadius": { "type": "integer" }, "size": { "type": "integer" }, "aspectRatio": { "type": "integer" }, "url": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] } }, "required": [ "effects", "borderRadius", "size", "aspectRatio", "url" ] }, "url": { "type": "object", "properties": { "visible": { "type": "boolean" }, "href": { "type": "string" }, "label": { "type": "string" } }, "required": [ "visible", "href", "label" ] }, "nationality": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "dob": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "visible", "text" ] }, "openToOnSite": { "type": "boolean" }, "country": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "lname": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "openToRelocate": { "type": "boolean" }, "city": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "phone": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "location": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "state": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "targetJobTitle": { "type": "object", "properties": { "visible": { "type": "boolean" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" }, "text": { "type": "string" } }, "required": [ "visible", "path", "beforeText", "afterText", "text" ] }, "headline": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "rawName": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "email": { "type": "object", "properties": { "visible": { "type": "boolean" }, "text": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" } }, "required": [ "visible", "text", "path", "beforeText", "afterText" ] }, "fname": { "type": "object", "properties": { "visible": { "type": "boolean" }, "path": { "type": "array", "items": { "type": "string" } }, "beforeText": { "type": "string" }, "afterText": { "type": "string" }, "text": { "type": "string" } }, "required": [ "visible", "path", "beforeText", "afterText", "text" ] } }, "required": [ "gender", "customFields", "postalCode", "openToRemote", "openToHybrid", "address", "openTo", "openToTravel", "picture", "url", "nationality", "dob", "openToOnSite", "country", "lname", "openToRelocate", "city", "phone", "location", "state", "targetJobTitle", "headline", "rawName", "email", "fname" ] } }, "required": [ "metadata", "sections", "basics" ] } }, "required": [ "jobTitle", "jobDescription", "rawText", "resumeScore", "resumeAnalysis", "resumeSkillScore", "resumeSectionFields" ] } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Update resume content by its ID. Supports bulk updates to multiple resume sections in a single request. Pass `userId` as a query parameter to specify the student." } }, "/jobTracker/v2/linkContacts": { "post": { "tags": [ "Job Tracker" ], "summary": "Link Contact to Job Card", "operationId": "post_jobtrackerlinkcontacts", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "boardId": { "type": "string" }, "jobCardId": { "type": "string" }, "contactId": { "type": "string" } }, "required": [ "boardId", "jobCardId", "contactId" ] }, "example": { "boardId": "{boardId}", "jobCardId": "{jobCardId}", "contactId": "{contactId}" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_writeTime": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] } }, "required": [ "_writeTime" ] }, "example": { "_writeTime": { "_seconds": 0, "_nanoseconds": 0 } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Associate a contact with a specific job card on a board. Pass `userid` as a query parameter to specify the student." }, "get": { "tags": [ "Job Tracker" ], "summary": "Get Linked Contacts", "operationId": "get_jobtrackerlinkcontacts", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "boardId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{boardId}" }, { "name": "jobCardId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{jobCardId}" }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "fname": { "type": "string" }, "created": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] }, "jobTitle": { "type": "string" }, "profilePic": { "type": "string" }, "networking": { "type": "array", "items": { "type": "object", "properties": { "followUp": { "type": "string" }, "goal": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "string" } }, "required": [ "followUp", "goal", "description", "title", "status" ] } }, "source": { "type": "string" }, "socialMedia": { "type": "object", "properties": { "gmail": { "type": "string" }, "twitter": { "type": "string" }, "github": { "type": "string" }, "linkedin": { "type": "string" }, "fb": { "type": "string" } }, "required": [ "gmail", "twitter", "github", "linkedin", "fb" ] }, "isActive": { "type": "boolean" }, "phoneNo": { "type": "array", "items": { "type": "string" } }, "lname": { "type": "string" }, "createdBy": { "type": "string" }, "company": { "type": "string" }, "location": { "type": "string" }, "tag": { "type": "string" }, "email": { "type": "array", "items": { "type": "string" } }, "linkedJobs": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } }, "required": [ "fname", "created", "jobTitle", "profilePic", "networking", "source", "socialMedia", "isActive", "phoneNo", "lname", "createdBy", "company", "location", "tag", "email", "linkedJobs", "id" ] } }, "example": [ { "fname": "string", "created": { "_seconds": 0, "_nanoseconds": 0 }, "jobTitle": "string", "profilePic": "string", "networking": [ { "followUp": "string", "goal": "string", "description": "string", "title": "string", "status": "string" }, { "followUp": "string", "goal": "string", "description": "string", "title": "string", "status": "string" } ], "source": "string", "socialMedia": { "gmail": "string", "twitter": "string", "github": "string", "linkedin": "string", "fb": "string" }, "isActive": true, "phoneNo": [ "string", "string" ], "lname": "string", "createdBy": "string", "company": "string", "location": "string", "tag": "string", "email": [ "string", "string" ], "linkedJobs": [ "string", "string" ], "id": "string" }, { "fname": "string", "created": { "_seconds": 0, "_nanoseconds": 0 }, "jobTitle": "string", "profilePic": "string", "networking": [ { "followUp": "string", "goal": "string", "description": "string", "title": "string", "status": "string" }, { "followUp": "string", "goal": "string", "description": "string", "title": "string", "status": "string" } ], "source": "string", "socialMedia": { "gmail": "string", "twitter": "string", "github": "string", "linkedin": "string", "fb": "string" }, "isActive": true, "phoneNo": [ "string", "string" ], "lname": "string", "createdBy": "string", "company": "string", "location": "string", "tag": "string", "email": [ "string", "string" ], "linkedJobs": [ "string", "string" ], "id": "string" } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all contacts linked to a specific job card. Requires `boardId` and `jobCardId` query parameters." }, "put": { "tags": [ "Job Tracker" ], "summary": "Unlink Contact from Job Card", "operationId": "put_jobtrackerlinkcontacts", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "boardId": { "type": "string" }, "jobCardId": { "type": "string" }, "contactId": { "type": "string" } }, "required": [ "boardId", "jobCardId", "contactId" ] }, "example": { "boardId": "{boardId}", "jobCardId": "{jobCardId}", "contactId": "{contactId}" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "string" }, "example": "" } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Remove the association between a contact and a job card." } }, "/jobTracker/v2/linkDocuments": { "post": { "tags": [ "Job Tracker" ], "summary": "Link Document to Job Card", "operationId": "post_jobtrackerlinkdocuments", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "boardId": { "type": "string" }, "jobCardId": { "type": "string" }, "documentId": { "type": "string" } }, "required": [ "boardId", "jobCardId", "documentId" ] }, "example": { "boardId": "string", "jobCardId": "string", "documentId": "string" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_writeTime": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] } }, "required": [ "_writeTime" ] }, "example": { "_writeTime": { "_seconds": 0, "_nanoseconds": 0 } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Associate a document (e.g. resume) with a specific job card on a board. Pass `userid` as a query parameter to specify the student." }, "get": { "tags": [ "Job Tracker" ], "summary": "Get Linked Documents", "operationId": "get_jobtrackerlinkdocuments", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "boardId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" }, { "name": "jobCardId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "category": { "type": "string" }, "isActive": { "type": "boolean" }, "linkedJobs": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "documentPath": { "type": "string" }, "url": { "type": "string" }, "resumeId": { "type": "string" }, "type": { "type": "string" } }, "required": [ "created", "description", "title", "category", "isActive", "linkedJobs", "id", "documentPath", "url", "resumeId", "type" ] } }, "example": [ { "created": { "_seconds": 0, "_nanoseconds": 0 }, "description": "string", "title": "string", "category": "string", "isActive": true, "linkedJobs": [ "string", "string" ], "id": "string", "documentPath": "string", "url": "string", "resumeId": "string", "type": "string" }, { "created": { "_seconds": 0, "_nanoseconds": 0 }, "description": "string", "title": "string", "category": "string", "isActive": true, "linkedJobs": [ "string", "string" ], "id": "string", "documentPath": "string", "url": "string", "resumeId": "string", "type": "string" } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all documents linked to a specific job card. Requires `boardId` and `jobCardId` query parameters." }, "put": { "tags": [ "Job Tracker" ], "summary": "Unlink Document from Job Card", "operationId": "put_jobtrackerlinkdocuments", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "boardId": { "type": "string" }, "jobCardId": { "type": "string" }, "documentId": { "type": "string" } }, "required": [ "boardId", "jobCardId", "documentId" ] }, "example": { "boardId": "string", "jobCardId": "string", "documentId": "string" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "string" }, "example": "" } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Remove the association between a document and a job card." } }, "/jobTracker/v2/job": { "post": { "tags": [ "Job Tracker" ], "summary": "Create Job Card", "operationId": "post_jobtrackerjob", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "boardId": { "type": "string" }, "companyId": { "type": "string" }, "jobTitle": { "type": "string" }, "description": { "type": "string" }, "company": { "type": "string" }, "url": { "type": "string" }, "location": { "type": "string" }, "sectionTitle": { "type": "string" }, "JobType": { "type": "string" }, "isActive": { "type": "boolean" }, "lastModified": { "type": "integer" }, "logo": { "type": "string" }, "companyPayload": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "website": { "type": "string" }, "logoUrl": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "website", "logoUrl", "description" ] }, "jobCard": { "type": "object", "properties": { "companyId": { "type": "string" }, "jobTitle": { "type": "string" }, "companyName": { "type": "string" }, "jobUrl": { "type": "string" }, "sectionName": { "type": "string" }, "lastModified": { "type": "integer" }, "logo": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "string" }, "notes": { "type": "array", "items": { "type": "string" } } }, "required": [ "companyId", "jobTitle", "companyName", "jobUrl", "sectionName", "lastModified", "logo", "description", "location", "notes" ] } }, "required": [ "boardId", "companyId", "jobTitle", "description", "company", "url", "location", "sectionTitle", "JobType", "isActive", "lastModified", "logo", "companyPayload", "jobCard" ] }, "example": { "boardId": "string", "companyId": "string", "jobTitle": "string", "description": "string", "company": "string", "url": "string", "location": "string", "sectionTitle": "string", "JobType": "string", "isActive": true, "lastModified": 0, "logo": "string", "companyPayload": { "id": "string", "name": "string", "website": "string", "logoUrl": "string", "description": "string" }, "jobCard": { "companyId": "string", "jobTitle": "string", "companyName": "string", "jobUrl": "string", "sectionName": "string", "lastModified": 0, "logo": "string", "description": "string", "location": "string", "notes": [] } } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "string" }, "example": "string" } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Create a new job card with company name, job title, description, and board placement. Pass `userId` as a query parameter to specify the student." } }, "/jobTracker/v2/job/details": { "get": { "tags": [ "Job Tracker" ], "summary": "Get Job Card Details", "operationId": "get_jobtrackerjobdetails", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" }, { "name": "boardId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{boardId}" }, { "name": "jobCardId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{jobCardId}" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobData": { "type": "object", "properties": { "notes": { "type": "array", "items": { "type": "string" } }, "documents": { "type": "array", "items": { "type": "string" } }, "jobTitle": { "type": "string" }, "companyName": { "type": "string" }, "description": { "type": "string" }, "postingDate": { "type": "integer" }, "isActive": { "type": "boolean" }, "salary": { "type": "string" }, "createdAt": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] }, "sectionTitle": { "type": "string" }, "companyPayload": { "type": "object", "properties": { "website": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "logoUrl": { "type": "string" } }, "required": [ "website", "name", "description", "id", "logoUrl" ] }, "companyLogoUrl": { "type": "string" }, "logo": { "type": "string" }, "jobUrl": { "type": "string" }, "company": { "type": "string" }, "jobType": { "type": "string" }, "creator": { "type": "object", "properties": { "name": { "type": "string" }, "userId": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "userId", "email" ] }, "url": { "type": "string" }, "jobCard": { "type": "object", "properties": { "sectionName": { "type": "string" }, "companyId": { "type": "string" }, "notes": { "type": "array", "items": { "type": "string" } }, "jobTitle": { "type": "string" }, "companyName": { "type": "string" }, "jobUrl": { "type": "string" }, "logo": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "string" }, "lastModified": { "type": "integer" } }, "required": [ "sectionName", "companyId", "notes", "jobTitle", "companyName", "jobUrl", "logo", "description", "location", "lastModified" ] }, "jobId": { "type": "string" }, "companyId": { "type": "string" }, "JobType": { "type": "string" }, "boardId": { "type": "string" }, "location": { "type": "string" }, "lastModified": { "type": "integer" }, "contacts": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "deadline": { "type": "string" }, "userid": { "type": "string" }, "jobcardId": { "type": "string" } }, "required": [ "notes", "documents", "jobTitle", "companyName", "description", "postingDate", "isActive", "salary", "createdAt", "sectionTitle", "companyPayload", "companyLogoUrl", "logo", "jobUrl", "company", "jobType", "creator", "url", "jobCard", "jobId", "companyId", "JobType", "boardId", "location", "lastModified", "contacts", "id", "deadline", "userid", "jobcardId" ] }, "notes": { "type": "array", "items": { "type": "string" } }, "company": { "type": "object", "properties": { "website": { "type": "string" }, "created": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "logoUrl": { "type": "string" } }, "required": [ "website", "created", "name", "description", "id", "logoUrl" ] }, "contacts": { "type": "array", "items": { "type": "string" } }, "documents": { "type": "array", "items": { "type": "string" } } }, "required": [ "jobData", "notes", "company", "contacts", "documents" ] }, "example": { "jobData": { "notes": [], "documents": [], "jobTitle": "string", "companyName": "string", "description": "string", "postingDate": 0, "isActive": true, "salary": "string", "createdAt": { "_seconds": 0, "_nanoseconds": 0 }, "sectionTitle": "string", "companyPayload": { "website": "string", "name": "string", "description": "string", "id": "string", "logoUrl": "string" }, "companyLogoUrl": "string", "logo": "string", "jobUrl": "string", "company": "string", "jobType": "string", "creator": { "name": "string", "userId": "string", "email": "string" }, "url": "string", "jobCard": { "sectionName": "string", "companyId": "string", "notes": [], "jobTitle": "string", "companyName": "string", "jobUrl": "string", "logo": "string", "description": "string", "location": "string", "lastModified": 0 }, "jobId": "string", "companyId": "string", "JobType": "string", "boardId": "string", "location": "string", "lastModified": 0, "contacts": [], "id": "string", "deadline": "string", "userid": "string", "jobcardId": "string" }, "notes": [], "company": { "website": "string", "created": { "_seconds": 0, "_nanoseconds": 0 }, "name": "string", "description": "string", "id": "string", "logoUrl": "string" }, "contacts": [], "documents": [] } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve complete details for a job card including parsed description, company info, linked contacts, and documents. Requires `boardId` and `jobCardId` query parameters." } }, "/jobTracker/v2/activity/jobCard/{jobCardId}": { "get": { "tags": [ "Job Tracker" ], "summary": "Get Job Card Activity", "operationId": "get_jobtrackeractivityjobcardjobcardid", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "jobCardId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The jobCardId identifier." }, { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "name": { "type": "string" }, "photo": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "name", "photo", "userId" ] }, "creator": { "type": "object", "properties": { "name": { "type": "string" }, "photo": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "name", "photo", "userId" ] }, "description": { "type": "string" }, "entityId": { "type": "string" }, "title": { "type": "string" }, "createdAt": { "type": "integer" }, "jobCardId": { "type": "string" }, "entityName": { "type": "string" }, "action": { "type": "string" }, "boardId": { "type": "string" }, "userType": { "type": "string" }, "jobTitle": { "type": "string" }, "companyName": { "type": "string" }, "sectionTo": { "type": "string" }, "companyId": { "type": "string" }, "sectionFrom": { "type": "string" }, "instituteId": { "type": "string" } }, "required": [ "owner", "creator", "description", "entityId", "title", "createdAt", "jobCardId", "entityName", "action", "boardId", "userType", "jobTitle", "companyName", "sectionTo", "companyId", "sectionFrom", "instituteId" ] } }, "example": [ { "owner": { "name": "string", "photo": "string", "userId": "string" }, "creator": { "name": "string", "photo": "string", "userId": "string" }, "description": "string", "entityId": "string", "title": "string", "createdAt": 0, "jobCardId": "string", "entityName": "string", "action": "string", "boardId": "string", "userType": "string", "jobTitle": "string", "companyName": "string", "sectionTo": "string", "companyId": "string", "sectionFrom": "string", "instituteId": "string" }, { "owner": { "name": "string", "photo": "string", "userId": "string" }, "creator": { "name": "string", "photo": "string", "userId": "string" }, "description": "string", "entityId": "string", "title": "string", "createdAt": 0, "jobCardId": "string", "entityName": "string", "action": "string", "boardId": "string", "userType": "string", "jobTitle": "string", "companyName": "string", "sectionTo": "string", "companyId": "string", "sectionFrom": "string", "instituteId": "string" } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve the activity history (create, update, move, etc.) for a specific job card." } }, "/jobTracker/v2/tasks": { "post": { "tags": [ "Job Tracker" ], "summary": "Create Task", "operationId": "post_jobtrackertasks", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string" }, "jobCardId": { "type": "string" }, "createdAt": { "type": "integer" }, "creator": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "email", "name" ] } }, "required": [ "title", "description", "state", "jobCardId", "createdAt", "creator" ] }, "example": { "title": "string", "description": "string", "state": "string", "jobCardId": "string", "createdAt": 0, "creator": { "email": "string", "name": "string" } } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_firestore": { "type": "object", "properties": { "projectId": { "type": "string" } }, "required": [ "projectId" ] }, "_path": { "type": "object", "properties": { "segments": { "type": "array", "items": { "type": "string" } } }, "required": [ "segments" ] }, "_converter": { "type": "string" } }, "required": [ "_firestore", "_path", "_converter" ] }, "example": { "_firestore": { "projectId": "string" }, "_path": { "segments": [ "string", "string" ] }, "_converter": "" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Create a new task optionally linked to a job card. Pass `userid` as a query parameter to specify the student." } }, "/jobTracker/v2/tasks/jobCard/{jobcardId}": { "get": { "tags": [ "Job Tracker" ], "summary": "List Tasks for Job Card", "operationId": "get_jobtrackertasksjobcardcmlna0qkwl7pfxa9svmf", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "jobcardId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The jobcardId identifier." }, { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "integer" }, "creator": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "jobCardId": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "createdAt", "creator", "jobCardId", "description", "state", "title" ] } }, "example": [ { "id": "string", "createdAt": 0, "creator": { "name": "string", "email": "string" }, "jobCardId": "string", "description": "string", "state": "string", "title": "string" }, { "id": "string", "createdAt": 0, "creator": { "name": "string", "email": "string" }, "jobCardId": "string", "description": "string", "state": "string", "title": "string" } ] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all tasks associated with a specific job card." } }, "/jobTracker/v2/tasks/{taskId}": { "put": { "tags": [ "Job Tracker" ], "summary": "Update Task", "operationId": "put_jobtrackertasksg4k9zatkhqaufkzubtgx", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The taskId identifier." }, { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "integer" }, "creator": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "jobCardId": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "createdAt", "creator", "jobCardId", "description", "state", "title" ] }, "example": { "id": "string", "createdAt": 0, "creator": { "name": "string", "email": "string" }, "jobCardId": "string", "description": "string", "state": "string", "title": "string" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_writeTime": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] } }, "required": [ "_writeTime" ] }, "example": { "_writeTime": { "_seconds": 0, "_nanoseconds": 0 } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Update task details such as title, description, due date, or completion status." } }, "/aiTools/v2/generate/cover-letter": { "post": { "tags": [ "AI Tools" ], "summary": "Generate Cover Letter", "operationId": "post_aitoolsgeneratecoverletter", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userid": { "type": "string" }, "targetJobTitle": { "type": "string" }, "job_description": { "type": "string" }, "linkedin_profile": { "type": "string" }, "resume": { "type": "string" }, "resumeId": { "type": "string" }, "length": { "type": "string" }, "tone": { "type": "string" }, "previousResult": { "type": "string" }, "companyName": { "type": "string" }, "resumeTitle": { "type": "string" }, "additionalContext": { "type": "string" }, "source": { "type": "string" }, "language": { "type": "string" } }, "required": [ "userid", "targetJobTitle", "job_description", "linkedin_profile", "resume", "resumeId", "length", "tone", "previousResult", "companyName", "resumeTitle", "additionalContext", "source", "language" ] }, "example": { "userid": "{userId}", "targetJobTitle": "string", "job_description": "string", "linkedin_profile": "string", "resume": "string", "resumeId": "string", "length": "string", "tone": "string", "previousResult": "string", "companyName": "string", "resumeTitle": "string", "additionalContext": "string", "source": "string", "language": "string" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" }, "id": { "type": "string" } }, "required": [ "content", "id" ] }, "example": { "content": "string", "id": "string" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate an AI-powered cover letter based on a job description and the student's resume or profile details." } }, "/aiTools/v2/generate/elevatorPitch": { "post": { "tags": [ "AI Tools" ], "summary": "Generate Elevator Pitch", "operationId": "post_aitoolsgenerateelevatorpitch", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "targetJobTitle": { "type": "string" }, "resume": { "type": "string" }, "resumeId": { "type": "string" }, "linkedin_profile": { "type": "string" }, "length": { "type": "string" }, "targetAudience": { "type": "string" }, "focusArea": { "type": "string" }, "tone": { "type": "string" }, "purpose": { "type": "string" }, "additionalContext": { "type": "string" }, "source": { "type": "string" }, "language": { "type": "string" } }, "required": [ "name", "targetJobTitle", "resume", "resumeId", "linkedin_profile", "length", "targetAudience", "focusArea", "tone", "purpose", "additionalContext", "source", "language" ] }, "example": { "name": "string", "targetJobTitle": "string", "resume": "string", "resumeId": "string", "linkedin_profile": "string", "length": "string", "targetAudience": "string", "focusArea": "string", "tone": "string", "purpose": "string", "additionalContext": "string", "source": "string", "language": "string" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" } }, "required": [ "id", "content" ] }, "example": { "id": "string", "content": "string" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate an AI-powered elevator pitch based on the student's profile and experience." } }, "/aiTools/v2/generate/linkedin/headline": { "post": { "tags": [ "AI Tools" ], "summary": "Generate LinkedIn Headline", "operationId": "post_aitoolsgeneratelinkedinheadline", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userid": { "type": "string" }, "targetJobTitle": { "type": "string" }, "name": { "type": "string" }, "keywords_to_include": { "type": "array", "items": { "type": "string" } }, "resume": { "type": "string" }, "resumeId": { "type": "string" }, "linkedin_profile": { "type": "string" }, "source": { "type": "string" }, "language": { "type": "string" } }, "required": [ "userid", "targetJobTitle", "name", "keywords_to_include", "resume", "resumeId", "linkedin_profile", "source", "language" ] }, "example": { "userid": "string", "targetJobTitle": "string", "name": "string", "keywords_to_include": [ "string", "string" ], "resume": "string", "resumeId": "string", "linkedin_profile": "string", "source": "string", "language": "string" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" }, "id": { "type": "string" } }, "required": [ "content", "id" ] }, "example": { "content": "string", "id": "string" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate an optimized LinkedIn headline using AI based on the student's profile." } }, "/aiTools/v2/generate/linkedin/about": { "post": { "tags": [ "AI Tools" ], "summary": "Generate LinkedIn About Section", "operationId": "post_aitoolsgeneratelinkedinabout", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userid": { "type": "string" }, "keywords_to_include": { "type": "array", "items": { "type": "string" } }, "speech_type": { "type": "string" }, "name": { "type": "string" }, "targetJobTitle": { "type": "string" }, "additionalOptions": { "type": "object", "properties": { "emojis": { "type": "boolean" }, "bulletPoints": { "type": "boolean" } }, "required": [ "emojis", "bulletPoints" ] }, "resume": { "type": "string" }, "resumeId": { "type": "string" }, "linkedin_profile": { "type": "string" }, "length": { "type": "string" }, "tone": { "type": "string" }, "source": { "type": "string" }, "language": { "type": "string" } }, "required": [ "userid", "keywords_to_include", "speech_type", "name", "targetJobTitle", "additionalOptions", "resume", "resumeId", "linkedin_profile", "length", "tone", "source", "language" ] }, "example": { "userid": "string", "keywords_to_include": [ "string", "string" ], "speech_type": "string", "name": "string", "targetJobTitle": "string", "additionalOptions": { "emojis": true, "bulletPoints": true }, "resume": "string", "resumeId": "string", "linkedin_profile": "string", "length": "string", "tone": "string", "source": "string", "language": "string" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" }, "id": { "type": "string" } }, "required": [ "content", "id" ] }, "example": { "content": "string", "id": "string" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate an AI-written LinkedIn about/summary section based on the student's profile." } }, "/aiTools/v2/history/linkedin-post": { "get": { "tags": [ "AI Tools" ], "summary": "Get LinkedIn Post History", "operationId": "get_aitoolshistorylinkedinpost", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "{userId}" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve previously generated LinkedIn posts for a student. Pass `userid` as a query parameter." } }, "/aiTools/v2/history/ELEVATOR_PITCH": { "get": { "tags": [ "AI Tools" ], "summary": "Get Elevator Pitch History", "operationId": "get_aitoolshistoryelevatorpitch", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve previously generated elevator pitches for a student. Pass `userid` as a query parameter." } }, "/aiTools/v2/history/headline": { "get": { "tags": [ "AI Tools" ], "summary": "Get LinkedIn Headline History", "operationId": "get_aitoolshistoryheadline", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve previously generated LinkedIn headlines for a student. Pass `userid` as a query parameter." } }, "/aiTools/v2/history/about": { "get": { "tags": [ "AI Tools" ], "summary": "Get LinkedIn About History", "operationId": "get_aitoolshistoryabout", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userid", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve previously generated LinkedIn about sections for a student. Pass `userid` as a query parameter." } }, "/instituteApp/v2/institute/{instituteId}/webhook/config": { "post": { "tags": [ "Webhooks" ], "summary": "Create Webhook Subscription", "operationId": "post_setup_webhook_subscription", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" } }, "required": [ "url", "events", "name" ] }, "example": { "url": "https://webhook.site/954108b0-6cc1-422b-a128-7819c5bc1a07", "events": [ "job.updated" ], "name": "Job Updated" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Create a new webhook subscription. Provide the target URL and the list of event types to subscribe to. A signing secret is generated automatically and returned in the response." }, "get": { "tags": [ "Webhooks" ], "summary": "List Webhook Subscriptions", "operationId": "get_fetch_webhook_subscriptions", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all webhook subscriptions configured for the institute." } }, "/instituteApp/v2/institute/{instituteId}/webhook/config/{webhookId}": { "put": { "tags": [ "Webhooks" ], "summary": "Update Webhook Subscription", "operationId": "put_disableenable_webhook_subscription_by_id", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The webhookId identifier." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "required": [ "isActive" ] }, "example": { "isActive": false } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Update a webhook subscription's URL, subscribed events, name, or enabled/disabled status." }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete Webhook Subscription", "operationId": "delete_delete_subscription_by_id", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The webhookId identifier." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Permanently delete a webhook subscription. The webhook will stop receiving events immediately." }, "get": { "tags": [ "Webhooks" ], "summary": "Get Webhook Subscription", "operationId": "get_fetch_subscription_by_id", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." }, { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The webhookId identifier." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve a specific webhook subscription by its ID." } }, "/instituteApp/v2/institute/{instituteId}/webhook/activities": { "get": { "tags": [ "Webhooks" ], "summary": "List Webhook Events", "operationId": "get_list_all_webhook_events", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." }, { "name": "events", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Array of events" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve the delivery log for webhook events. Supports filtering by event type and delivery status via query parameters." } }, "/stats/v1/get_external_bigquery_data": { "post": { "tags": [ "Data Endpoints" ], "summary": "Query Analytics Data", "operationId": "post_applied_jobs_data", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "institute_id", "in": "query", "required": false, "schema": { "type": "string" }, "example": "io-sphere" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2024-01-01" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2024-12-03" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query_type": { "type": "string" }, "aggregate": { "type": "string" } }, "required": [ "query_type", "aggregate" ] }, "example": { "query_type": "applied_jobs_stats", "aggregate": "daily" } } } }, "responses": { "200": { "description": "Daily", "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "object", "properties": { "0": { "type": "integer" }, "1": { "type": "integer" }, "2": { "type": "integer" }, "3": { "type": "integer" }, "4": { "type": "integer" }, "5": { "type": "integer" }, "6": { "type": "integer" }, "7": { "type": "integer" }, "8": { "type": "integer" }, "9": { "type": "integer" }, "10": { "type": "integer" }, "11": { "type": "integer" }, "12": { "type": "integer" }, "13": { "type": "integer" }, "14": { "type": "integer" }, "15": { "type": "integer" }, "16": { "type": "integer" }, "17": { "type": "integer" }, "18": { "type": "integer" }, "19": { "type": "integer" }, "20": { "type": "integer" }, "21": { "type": "integer" }, "22": { "type": "integer" }, "23": { "type": "integer" }, "24": { "type": "integer" }, "25": { "type": "integer" }, "26": { "type": "integer" }, "27": { "type": "integer" }, "28": { "type": "integer" }, "29": { "type": "integer" }, "30": { "type": "integer" }, "31": { "type": "integer" }, "32": { "type": "integer" }, "33": { "type": "integer" }, "34": { "type": "integer" }, "35": { "type": "integer" }, "36": { "type": "integer" }, "37": { "type": "integer" }, "38": { "type": "integer" }, "39": { "type": "integer" }, "40": { "type": "integer" }, "41": { "type": "integer" }, "42": { "type": "integer" }, "43": { "type": "integer" }, "44": { "type": "integer" }, "45": { "type": "integer" }, "46": { "type": "integer" }, "47": { "type": "integer" }, "48": { "type": "integer" }, "49": { "type": "integer" }, "50": { "type": "integer" }, "51": { "type": "integer" }, "52": { "type": "integer" }, "53": { "type": "integer" }, "54": { "type": "integer" }, "55": { "type": "integer" }, "56": { "type": "integer" }, "57": { "type": "integer" }, "58": { "type": "integer" }, "59": { "type": "integer" }, "60": { "type": "integer" }, "61": { "type": "integer" }, "62": { "type": "integer" }, "63": { "type": "integer" }, "64": { "type": "integer" }, "65": { "type": "integer" }, "66": { "type": "integer" }, "67": { "type": "integer" }, "68": { "type": "integer" }, "69": { "type": "integer" }, "70": { "type": "integer" }, "71": { "type": "integer" }, "72": { "type": "integer" }, "73": { "type": "integer" }, "74": { "type": "integer" }, "75": { "type": "integer" }, "76": { "type": "integer" }, "77": { "type": "integer" }, "78": { "type": "integer" }, "79": { "type": "integer" }, "80": { "type": "integer" }, "81": { "type": "integer" }, "82": { "type": "integer" }, "83": { "type": "integer" }, "84": { "type": "integer" }, "85": { "type": "integer" }, "86": { "type": "integer" }, "87": { "type": "integer" }, "88": { "type": "integer" }, "89": { "type": "integer" }, "90": { "type": "integer" }, "91": { "type": "integer" }, "92": { "type": "integer" }, "93": { "type": "integer" }, "94": { "type": "integer" }, "95": { "type": "integer" }, "96": { "type": "integer" }, "97": { "type": "integer" }, "98": { "type": "integer" }, "99": { "type": "integer" }, "100": { "type": "integer" }, "101": { "type": "integer" }, "102": { "type": "integer" }, "103": { "type": "integer" }, "104": { "type": "integer" }, "105": { "type": "integer" }, "106": { "type": "integer" }, "107": { "type": "integer" }, "108": { "type": "integer" }, "109": { "type": "integer" }, "110": { "type": "integer" }, "111": { "type": "integer" }, "112": { "type": "integer" }, "113": { "type": "integer" }, "114": { "type": "integer" }, "115": { "type": "integer" }, "116": { "type": "integer" }, "117": { "type": "integer" }, "118": { "type": "integer" }, "119": { "type": "integer" }, "120": { "type": "integer" }, "121": { "type": "integer" }, "122": { "type": "integer" }, "123": { "type": "integer" }, "124": { "type": "integer" }, "125": { "type": "integer" }, "126": { "type": "integer" }, "127": { "type": "integer" }, "128": { "type": "integer" }, "129": { "type": "integer" }, "130": { "type": "integer" }, "131": { "type": "integer" }, "132": { "type": "integer" }, "133": { "type": "integer" }, "134": { "type": "integer" }, "135": { "type": "integer" }, "136": { "type": "integer" }, "137": { "type": "integer" }, "138": { "type": "integer" }, "139": { "type": "integer" }, "140": { "type": "integer" }, "141": { "type": "integer" }, "142": { "type": "integer" }, "143": { "type": "integer" }, "144": { "type": "integer" }, "145": { "type": "integer" }, "146": { "type": "integer" }, "147": { "type": "integer" }, "148": { "type": "integer" }, "149": { "type": "integer" }, "150": { "type": "integer" }, "151": { "type": "integer" }, "152": { "type": "integer" }, "153": { "type": "integer" }, "154": { "type": "integer" }, "155": { "type": "integer" }, "156": { "type": "integer" }, "157": { "type": "integer" }, "158": { "type": "integer" }, "159": { "type": "integer" }, "160": { "type": "integer" }, "161": { "type": "integer" }, "162": { "type": "integer" }, "163": { "type": "integer" }, "164": { "type": "integer" }, "165": { "type": "integer" }, "166": { "type": "integer" }, "167": { "type": "integer" }, "168": { "type": "integer" }, "169": { "type": "integer" }, "170": { "type": "integer" }, "171": { "type": "integer" }, "172": { "type": "integer" }, "173": { "type": "integer" }, "174": { "type": "integer" }, "175": { "type": "integer" }, "176": { "type": "integer" }, "177": { "type": "integer" }, "178": { "type": "integer" }, "179": { "type": "integer" }, "180": { "type": "integer" }, "181": { "type": "integer" }, "182": { "type": "integer" }, "183": { "type": "integer" }, "184": { "type": "integer" }, "185": { "type": "integer" }, "186": { "type": "integer" }, "187": { "type": "integer" }, "188": { "type": "integer" }, "189": { "type": "integer" }, "190": { "type": "integer" }, "191": { "type": "integer" }, "192": { "type": "integer" }, "193": { "type": "integer" }, "194": { "type": "integer" }, "195": { "type": "integer" }, "196": { "type": "integer" }, "197": { "type": "integer" }, "198": { "type": "integer" }, "199": { "type": "integer" } }, "required": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "51", "52", "53", "54", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "69", "70", "71", "72", "73", "74", "75", "76", "77", "78", "79", "80", "81", "82", "83", "84", "85", "86", "87", "88", "89", "90", "91", "92", "93", "94", "95", "96", "97", "98", "99", "100", "101", "102", "103", "104", "105", "106", "107", "108", "109", "110", "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166", "167", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199" ] }, "count": { "type": "object", "properties": { "0": { "type": "integer" }, "1": { "type": "integer" }, "2": { "type": "integer" }, "3": { "type": "integer" }, "4": { "type": "integer" }, "5": { "type": "integer" }, "6": { "type": "integer" }, "7": { "type": "integer" }, "8": { "type": "integer" }, "9": { "type": "integer" }, "10": { "type": "integer" }, "11": { "type": "integer" }, "12": { "type": "integer" }, "13": { "type": "integer" }, "14": { "type": "integer" }, "15": { "type": "integer" }, "16": { "type": "integer" }, "17": { "type": "integer" }, "18": { "type": "integer" }, "19": { "type": "integer" }, "20": { "type": "integer" }, "21": { "type": "integer" }, "22": { "type": "integer" }, "23": { "type": "integer" }, "24": { "type": "integer" }, "25": { "type": "integer" }, "26": { "type": "integer" }, "27": { "type": "integer" }, "28": { "type": "integer" }, "29": { "type": "integer" }, "30": { "type": "integer" }, "31": { "type": "integer" }, "32": { "type": "integer" }, "33": { "type": "integer" }, "34": { "type": "integer" }, "35": { "type": "integer" }, "36": { "type": "integer" }, "37": { "type": "integer" }, "38": { "type": "integer" }, "39": { "type": "integer" }, "40": { "type": "integer" }, "41": { "type": "integer" }, "42": { "type": "integer" }, "43": { "type": "integer" }, "44": { "type": "integer" }, "45": { "type": "integer" }, "46": { "type": "integer" }, "47": { "type": "integer" }, "48": { "type": "integer" }, "49": { "type": "integer" }, "50": { "type": "integer" }, "51": { "type": "integer" }, "52": { "type": "integer" }, "53": { "type": "integer" }, "54": { "type": "integer" }, "55": { "type": "integer" }, "56": { "type": "integer" }, "57": { "type": "integer" }, "58": { "type": "integer" }, "59": { "type": "integer" }, "60": { "type": "integer" }, "61": { "type": "integer" }, "62": { "type": "integer" }, "63": { "type": "integer" }, "64": { "type": "integer" }, "65": { "type": "integer" }, "66": { "type": "integer" }, "67": { "type": "integer" }, "68": { "type": "integer" }, "69": { "type": "integer" }, "70": { "type": "integer" }, "71": { "type": "integer" }, "72": { "type": "integer" }, "73": { "type": "integer" }, "74": { "type": "integer" }, "75": { "type": "integer" }, "76": { "type": "integer" }, "77": { "type": "integer" }, "78": { "type": "integer" }, "79": { "type": "integer" }, "80": { "type": "integer" }, "81": { "type": "integer" }, "82": { "type": "integer" }, "83": { "type": "integer" }, "84": { "type": "integer" }, "85": { "type": "integer" }, "86": { "type": "integer" }, "87": { "type": "integer" }, "88": { "type": "integer" }, "89": { "type": "integer" }, "90": { "type": "integer" }, "91": { "type": "integer" }, "92": { "type": "integer" }, "93": { "type": "integer" }, "94": { "type": "integer" }, "95": { "type": "integer" }, "96": { "type": "integer" }, "97": { "type": "integer" }, "98": { "type": "integer" }, "99": { "type": "integer" }, "100": { "type": "integer" }, "101": { "type": "integer" }, "102": { "type": "integer" }, "103": { "type": "integer" }, "104": { "type": "integer" }, "105": { "type": "integer" }, "106": { "type": "integer" }, "107": { "type": "integer" }, "108": { "type": "integer" }, "109": { "type": "integer" }, "110": { "type": "integer" }, "111": { "type": "integer" }, "112": { "type": "integer" }, "113": { "type": "integer" }, "114": { "type": "integer" }, "115": { "type": "integer" }, "116": { "type": "integer" }, "117": { "type": "integer" }, "118": { "type": "integer" }, "119": { "type": "integer" }, "120": { "type": "integer" }, "121": { "type": "integer" }, "122": { "type": "integer" }, "123": { "type": "integer" }, "124": { "type": "integer" }, "125": { "type": "integer" }, "126": { "type": "integer" }, "127": { "type": "integer" }, "128": { "type": "integer" }, "129": { "type": "integer" }, "130": { "type": "integer" }, "131": { "type": "integer" }, "132": { "type": "integer" }, "133": { "type": "integer" }, "134": { "type": "integer" }, "135": { "type": "integer" }, "136": { "type": "integer" }, "137": { "type": "integer" }, "138": { "type": "integer" }, "139": { "type": "integer" }, "140": { "type": "integer" }, "141": { "type": "integer" }, "142": { "type": "integer" }, "143": { "type": "integer" }, "144": { "type": "integer" }, "145": { "type": "integer" }, "146": { "type": "integer" }, "147": { "type": "integer" }, "148": { "type": "integer" }, "149": { "type": "integer" }, "150": { "type": "integer" }, "151": { "type": "integer" }, "152": { "type": "integer" }, "153": { "type": "integer" }, "154": { "type": "integer" }, "155": { "type": "integer" }, "156": { "type": "integer" }, "157": { "type": "integer" }, "158": { "type": "integer" }, "159": { "type": "integer" }, "160": { "type": "integer" }, "161": { "type": "integer" }, "162": { "type": "integer" }, "163": { "type": "integer" }, "164": { "type": "integer" }, "165": { "type": "integer" }, "166": { "type": "integer" }, "167": { "type": "integer" }, "168": { "type": "integer" }, "169": { "type": "integer" }, "170": { "type": "integer" }, "171": { "type": "integer" }, "172": { "type": "integer" }, "173": { "type": "integer" }, "174": { "type": "integer" }, "175": { "type": "integer" }, "176": { "type": "integer" }, "177": { "type": "integer" }, "178": { "type": "integer" }, "179": { "type": "integer" }, "180": { "type": "integer" }, "181": { "type": "integer" }, "182": { "type": "integer" }, "183": { "type": "integer" }, "184": { "type": "integer" }, "185": { "type": "integer" }, "186": { "type": "integer" }, "187": { "type": "integer" }, "188": { "type": "integer" }, "189": { "type": "integer" }, "190": { "type": "integer" }, "191": { "type": "integer" }, "192": { "type": "integer" }, "193": { "type": "integer" }, "194": { "type": "integer" }, "195": { "type": "integer" }, "196": { "type": "integer" }, "197": { "type": "integer" }, "198": { "type": "integer" }, "199": { "type": "integer" } }, "required": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "51", "52", "53", "54", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "69", "70", "71", "72", "73", "74", "75", "76", "77", "78", "79", "80", "81", "82", "83", "84", "85", "86", "87", "88", "89", "90", "91", "92", "93", "94", "95", "96", "97", "98", "99", "100", "101", "102", "103", "104", "105", "106", "107", "108", "109", "110", "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166", "167", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199" ] } }, "required": [ "date", "count" ] }, "example": { "date": { "0": 1733097600000, "1": 1733011200000, "2": 1732924800000, "3": 1732838400000, "4": 1732752000000, "5": 1732665600000, "6": 1732579200000, "7": 1732492800000, "8": 1732320000000, "9": 1732233600000, "10": 1732147200000, "11": 1732060800000, "12": 1731974400000, "13": 1731888000000, "14": 1731801600000, "15": 1731715200000, "16": 1731628800000, "17": 1731542400000, "18": 1731456000000, "19": 1731369600000, "20": 1731283200000, "21": 1731196800000, "22": 1731110400000, "23": 1731024000000, "24": 1730937600000, "25": 1730851200000, "26": 1730764800000, "27": 1730678400000, "28": 1730592000000, "29": 1730505600000, "30": 1730419200000, "31": 1730332800000, "32": 1730246400000, "33": 1730160000000, "34": 1730073600000, "35": 1729900800000, "36": 1729814400000, "37": 1729728000000, "38": 1729641600000, "39": 1729555200000, "40": 1729468800000, "41": 1729382400000, "42": 1729296000000, "43": 1729209600000, "44": 1729123200000, "45": 1729036800000, "46": 1728950400000, "47": 1728864000000, "48": 1728777600000, "49": 1728691200000, "50": 1728604800000, "51": 1728518400000, "52": 1728432000000, "53": 1728345600000, "54": 1728259200000, "55": 1728172800000, "56": 1728086400000, "57": 1728000000000, "58": 1727913600000, "59": 1727827200000, "60": 1727740800000, "61": 1727654400000, "62": 1727568000000, "63": 1727481600000, "64": 1727395200000, "65": 1727308800000, "66": 1727222400000, "67": 1727136000000, "68": 1727049600000, "69": 1726963200000, "70": 1726876800000, "71": 1726790400000, "72": 1726704000000, "73": 1726617600000, "74": 1726531200000, "75": 1726444800000, "76": 1726358400000, "77": 1726272000000, "78": 1726185600000, "79": 1726099200000, "80": 1726012800000, "81": 1725926400000, "82": 1725840000000, "83": 1725753600000, "84": 1725667200000, "85": 1725580800000, "86": 1725494400000, "87": 1725408000000, "88": 1725321600000, "89": 1725235200000, "90": 1725148800000, "91": 1725062400000, "92": 1724976000000, "93": 1724889600000, "94": 1724803200000, "95": 1724716800000, "96": 1724630400000, "97": 1724544000000, "98": 1724457600000, "99": 1724371200000, "100": 1724284800000, "101": 1724198400000, "102": 1724112000000, "103": 1724025600000, "104": 1723852800000, "105": 1723766400000, "106": 1723680000000, "107": 1723593600000, "108": 1723507200000, "109": 1723420800000, "110": 1723334400000, "111": 1723248000000, "112": 1723161600000, "113": 1723075200000, "114": 1722988800000, "115": 1722902400000, "116": 1722816000000, "117": 1722729600000, "118": 1722643200000, "119": 1722556800000, "120": 1722470400000, "121": 1722384000000, "122": 1722297600000, "123": 1722211200000, "124": 1722124800000, "125": 1722038400000, "126": 1721952000000, "127": 1721865600000, "128": 1721779200000, "129": 1721692800000, "130": 1721606400000, "131": 1721433600000, "132": 1721347200000, "133": 1721260800000, "134": 1721174400000, "135": 1721088000000, "136": 1721001600000, "137": 1720915200000, "138": 1720828800000, "139": 1720656000000, "140": 1720569600000, "141": 1720483200000, "142": 1720396800000, "143": 1720310400000, "144": 1720224000000, "145": 1720137600000, "146": 1720051200000, "147": 1719964800000, "148": 1719878400000, "149": 1719792000000, "150": 1719446400000, "151": 1719273600000, "152": 1719187200000, "153": 1719014400000, "154": 1718841600000, "155": 1718668800000, "156": 1718582400000, "157": 1718236800000, "158": 1718150400000, "159": 1718064000000, "160": 1717977600000, "161": 1717891200000, "162": 1717718400000, "163": 1717632000000, "164": 1717459200000, "165": 1717200000000, "166": 1716163200000, "167": 1715904000000, "168": 1715558400000, "169": 1715299200000, "170": 1715212800000, "171": 1715126400000, "172": 1715040000000, "173": 1714694400000, "174": 1714608000000, "175": 1714521600000, "176": 1714348800000, "177": 1714176000000, "178": 1714089600000, "179": 1714003200000, "180": 1713484800000, "181": 1713398400000, "182": 1713139200000, "183": 1712793600000, "184": 1712707200000, "185": 1712620800000, "186": 1712534400000, "187": 1712275200000, "188": 1712188800000, "189": 1712102400000, "190": 1712016000000, "191": 1711756800000, "192": 1711584000000, "193": 1711497600000, "194": 1711324800000, "195": 1711238400000, "196": 1711065600000, "197": 1710979200000, "198": 1710892800000, "199": 1704067200000 }, "count": { "0": 102, "1": 9, "2": 58, "3": 21, "4": 64, "5": 57, "6": 65, "7": 19, "8": 47, "9": 68, "10": 55, "11": 124, "12": 82, "13": 115, "14": 35, "15": 51, "16": 94, "17": 87, "18": 117, "19": 104, "20": 99, "21": 61, "22": 99, "23": 134, "24": 141, "25": 116, "26": 53, "27": 48, "28": 68, "29": 30, "30": 27, "31": 37, "32": 25, "33": 22, "34": 69, "35": 39, "36": 34, "37": 23, "38": 20, "39": 24, "40": 25, "41": 4, "42": 27, "43": 63, "44": 42, "45": 11, "46": 34, "47": 9, "48": 5, "49": 39, "50": 50, "51": 16, "52": 16, "53": 60, "54": 28, "55": 6, "56": 31, "57": 14, "58": 32, "59": 14, "60": 27, "61": 46, "62": 2, "63": 41, "64": 13, "65": 18, "66": 38, "67": 26, "68": 16, "69": 2, "70": 59, "71": 7, "72": 9, "73": 10, "74": 29, "75": 28, "76": 8, "77": 57, "78": 8, "79": 23, "80": 54, "81": 35, "82": 86, "83": 7, "84": 36, "85": 5, "86": 8, "87": 12, "88": 35, "89": 25, "90": 8, "91": 52, "92": 10, "93": 11, "94": 13, "95": 32, "96": 11, "97": 28, "98": 20, "99": 41, "100": 13, "101": 15, "102": 35, "103": 38, "104": 6, "105": 42, "106": 22, "107": 11, "108": 27, "109": 11, "110": 10, "111": 16, "112": 54, "113": 7, "114": 4, "115": 17, "116": 8, "117": 7, "118": 10, "119": 79, "120": 16, "121": 24, "122": 27, "123": 15, "124": 3, "125": 3, "126": 22, "127": 8, "128": 18, "129": 57, "130": 17, "131": 13, "132": 7, "133": 15, "134": 18, "135": 67, "136": 10, "137": 7, "138": 6, "139": 11, "140": 1, "141": 35, "142": 15, "143": 1, "144": 4, "145": 1, "146": 11, "147": 5, "148": 40, "149": 12, "150": 3, "151": 20, "152": 9, "153": 5, "154": 1, "155": 19, "156": 3, "157": 1, "158": 5, "159": 21, "160": 1, "161": 5, "162": 3, "163": 7, "164": 31, "165": 1, "166": 1, "167": 4, "168": 15, "169": 6, "170": 4, "171": 2, "172": 6, "173": 9, "174": 1, "175": 6, "176": 4, "177": 5, "178": 2, "179": 5, "180": 8, "181": 5, "182": 8, "183": 11, "184": 1, "185": 5, "186": 5, "187": 6, "188": 3, "189": 10, "190": 6, "191": 4, "192": 2, "193": 1, "194": 10, "195": 1, "196": 10, "197": 5, "198": 6, "199": 1 } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Query aggregated analytics data from BigQuery. Requires `institute_id`, `start_date`, and `end_date` query parameters. Only available in production." } }, "/scaleKitWebhookV2/scim/events": { "post": { "tags": [ "SCIM" ], "summary": "Process SCIM Events", "operationId": "post_scim_audit_logs", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" }, "example": "5" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "eventTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "eventTypes" ] }, "example": { "eventTypes": [] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Receive and process SCIM provisioning events from ScaleKit. Handles user creation, updates, and deactivation for students and coaches based on identity provider data." } }, "/jobTracker/v2/activity/institute": { "get": { "tags": [ "Audit Logs" ], "summary": "List Audit Logs by Institute", "operationId": "get_get_audit_logs_by_institute", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" }, "example": "5" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all audit log entries for the institute. Supports filtering by source (API or APP) and pagination via `pageSize` query parameter." } }, "/jobTracker/v2/activity/user/{userId}": { "get": { "tags": [ "Audit Logs" ], "summary": "List Audit Logs by User", "operationId": "get_get_audit_logs_by_user", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The userId identifier." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" }, "example": "5" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all audit log entries where the specified user is the subject. Supports pagination via `pageSize` query parameter." } }, "/jobTracker/v2/activity/creator/{userId}": { "get": { "tags": [ "Audit Logs" ], "summary": "List Audit Logs by Creator", "operationId": "get_get_audit_logs_by_creator", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The userId identifier." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" }, "example": "5" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all audit log entries created by the specified user. Supports pagination via `pageSize` query parameter." } }, "/jobTracker/v2/activity/logs": { "get": { "tags": [ "Application Logs" ], "summary": "List Application Logs", "operationId": "get_application_logs", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" }, "example": "100" } ], "responses": { "200": { "description": "Application Logs", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string" }, "level": { "type": "string" }, "message": { "type": "object", "properties": { "url": { "type": "string" }, "method": { "type": "string" }, "institute": { "type": "string" }, "timestamp": { "type": "integer" }, "request_headers": { "type": "object", "properties": { "sourceapp": { "type": "string" }, "accept-language": { "type": "string" }, "user-agent": { "type": "string" }, "x-forwarded-proto": { "type": "string" }, "institute": { "type": "string" }, "priority": { "type": "string" }, "x-cloud-trace-context": { "type": "string" }, "origin": { "type": "string" }, "accept-encoding": { "type": "string" }, "sec-ch-ua-platform": { "type": "string" }, "x-forwarded-for": { "type": "string" }, "host": { "type": "string" }, "referer": { "type": "string" }, "traceparent": { "type": "string" }, "forwarded": { "type": "string" }, "if-none-match": { "type": "string" }, "sec-ch-ua-mobile": { "type": "string" }, "accept": { "type": "string" }, "sec-fetch-mode": { "type": "string" }, "sec-ch-ua": { "type": "string" }, "treblle-user-id": { "type": "string" }, "sec-fetch-dest": { "type": "string" }, "sec-fetch-site": { "type": "string" } }, "required": [ "sourceapp", "accept-language", "user-agent", "x-forwarded-proto", "institute", "priority", "x-cloud-trace-context", "origin", "accept-encoding", "sec-ch-ua-platform", "x-forwarded-for", "host", "referer", "traceparent", "forwarded", "if-none-match", "sec-ch-ua-mobile", "accept", "sec-fetch-mode", "sec-ch-ua", "treblle-user-id", "sec-fetch-dest", "sec-fetch-site" ] }, "payload": { "type": "object", "properties": { "body": { "type": "object", "properties": {} }, "uuid": { "type": "string" }, "query": { "type": "object", "properties": {} }, "params": { "type": "object", "properties": {} } }, "required": [ "body", "uuid", "query", "params" ] }, "sourceApp": { "type": "string" } }, "required": [ "url", "method", "institute", "timestamp", "request_headers", "payload", "sourceApp" ] }, "request_id": { "type": "string" }, "logSize": { "type": "string" }, "spanId": { "type": "integer" }, "id": { "type": "string" } }, "required": [ "timestamp", "level", "message", "request_id", "logSize", "spanId", "id" ] } }, "pageToken": { "type": "string" } }, "required": [ "events", "pageToken" ] }, "example": { "events": [ { "timestamp": "2025-07-10T10:03:27.461Z", "level": "info", "message": { "url": "http://us-central1-faang-path-test.cloudfunctions.net/institute/careerflow", "method": "GET", "institute": "careerflow", "timestamp": 1752141807460, "request_headers": { "sourceapp": "COACH", "accept-language": "en-GB,en-US;q=0.9,en;q=0.8", "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36", "x-forwarded-proto": "https", "institute": "careerflow", "priority": "u=1, i", "x-cloud-trace-context": "6649c1b629a8db6ac65401688c8cbf32/18083321080710881221", "origin": "http://localhost:3001", "accept-encoding": "gzip, deflate, br, zstd", "sec-ch-ua-platform": "\"macOS\"", "x-forwarded-for": "2401:4900:1f28:3064:74fc:11a:114e:cb9f", "host": "us-central1-faang-path-test.cloudfunctions.net", "referer": "http://localhost:3001/", "traceparent": "00-6649c1b629a8db6ac65401688c8cbf32-faf4dcb69f1adfc5-00", "forwarded": "for=\"[2401:4900:1f28:3064:74fc:11a:114e:cb9f]\";proto=https", "if-none-match": "W/\"932-isdS5hWrOPc+72yKdGK/8asPhJE\"", "sec-ch-ua-mobile": "?0", "accept": "application/json, text/plain, */*", "sec-fetch-mode": "cors", "sec-ch-ua": "\"Not)A;Brand\";v=\"8\", \"Chromium\";v=\"138\", \"Google Chrome\";v=\"138\"", "treblle-user-id": "5z4lliJytARBeirRT40HHEiT7MC3", "sec-fetch-dest": "empty", "sec-fetch-site": "cross-site" }, "payload": { "body": {}, "uuid": "5z4lliJytARBeirRT40HHEiT7MC3", "query": {}, "params": {} }, "sourceApp": "COACH" }, "request_id": "1fcd7240-5d75-11f0-a9ea-5d0a8703bb7c", "logSize": "Size of info object: 4113 bytes", "spanId": "18083321080710881221", "id": "686f8fef000706655127e157" }, { "message": { "sourceApp": "JOB_SEEKER", "request_headers": { "accept-encoding": "gzip, deflate, br, zstd", "institute": "careerflow", "accept": "application/json, text/plain, */*", "x-forwarded-for": "2401:4900:1f28:3064:74fc:11a:114e:cb9f", "sec-ch-ua": "\"Not)A;Brand\";v=\"8\", \"Chromium\";v=\"138\", \"Google Chrome\";v=\"138\"", "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36", "priority": "u=1, i", "sec-fetch-site": "cross-site", "sec-fetch-dest": "empty", "treblle-user-id": "NmkNwvFbLVfRl8LTs6KM3FOw7wz2", "x-cloud-trace-context": "15f8694c52b55714c65401688c8cbc20/18376647419677987778", "referer": "http://localhost:3000/", "host": "us-central1-faang-path-test.cloudfunctions.net", "origin": "http://localhost:3000", "accept-language": "en-GB,en-US;q=0.9,en;q=0.8", "sec-fetch-mode": "cors", "x-forwarded-proto": "https", "traceparent": "00-15f8694c52b55714c65401688c8cbc20-ff06f776ec8153c2-00", "sourceapp": "JOB_SEEKER", "sec-ch-ua-platform": "\"macOS\"", "forwarded": "for=\"[2401:4900:1f28:3064:74fc:11a:114e:cb9f]\";proto=https", "if-none-match": "W/\"6a-oSfiyxd8Od1fuzs06C1T6SIaw2o\"", "sec-ch-ua-mobile": "?0" }, "url": "http://us-central1-faang-path-test.cloudfunctions.net/institute/careerflow/verifyInstituteStudent/student@example.com", "payload": { "uuid": "NmkNwvFbLVfRl8LTs6KM3FOw7wz2", "params": {}, "body": {}, "query": {} }, "method": "GET", "timestamp": 1752141807424, "institute": "careerflow" }, "level": "info", "request_id": "1fc7ccf0-5d75-11f0-a9ea-5d0a8703bb7c", "timestamp": "2025-07-10T10:03:27.424Z", "logSize": "Size of info object: 3038 bytes", "spanId": "18376647419677987778", "id": "686f8fef000679bcd8f0f4b2" } ], "pageToken": "eqgHCqMHAZ_n57MrjOpeE8cjWhnbgCq3kAWMm0wDvwmfKMlvZq2D9AgZJni6wLJdKdNbIPzWg_jNZXvUzwD6kmI9KqlNf_H3y83SzMr0CcFRpCuD2it3zcIUN4VOq3pHkvIM6l6b2h5Goy4NdFQpnw36Oq-vgzp4U98NMxP-kDeZbabm-SFWkEpmJ1anOQGOjk47uHFGoTgbJKPTPQKIz5XSiyyhSdJxzb2nJIFsRjmcaHb2yXa6psMHvU0RcqRo1EQYcJmr6Dk4bnYERP5cF6R_KhqUujT-ZNqyN-jNMyVwicsDD02iq_TjyZ0HA9iEiCtj2qoogUEguebbO4tG0UXjNRki7_NTJdqVscvIIXFADQVTVOO9Hs3EMv8q9Ut9v5aCgLMb8WzL3PwI5cKAqgasU8AMCEhs2gtDP4xbcKqCoUNu8FTpcoe3BVZLBc_Gp97O0IS8gXhH9lt8s94ArBM0gMAqnONCOYOHmAwETXnVJX2YAi2Wxsju3qKNnPlJZd_3Ztqp65JbMT8a7aoMFzowUv6wQ-EYOBnthXc7rugMv9i2w5DBRkBBKs93UGg9duhzeTeYAEikaK9BDcoLocyPVwC2fsp821CDNMlNgzreh_u6M3VBkydseuOndWGU0vwrXUt15Cr0VayxGR_lffCKKCGb55xhgdO1dAqCBXxIP6rqlFxgPQyAkmqj_-5Fww_2l_Ltp6OJ9i3h6YQ6yOnVTY9wFWHa9aAhFYCn7WwCUOadlPxDa6WuZCqasJmJy32v2mfnMkqEbOb4D3ItoHIZAbNBYGxGOGaLhOvLb0bS463jdrfFXH32-EgDYMzMyFRKqr2kp-o-GHZ6c4n_ccu0d2JykldS5zXeEA1RRaCSz_X6muWEWZ3s_H5LFkVRuG-LkXyTxgl94DqshAGdoCmskXccnBli1D2_2QvigbWV5dfVNz6VfK0HGwLjrDqZERnmYgd_MelYAxlFM05RO2c0nHD45sfl9i1zi40WagW0Xdrz9evta7HeTsiN1yVKpvA3KG6aGnp34_cbF90kpxjnLpSR4EZ0C-MnwNO9Hm2UwTGjq8GTsQESZXnD4YR0OTbfNJ7NMqnooi2TH-iDMvDXMGS4d6aD0YjV9mdHijoeQBhUmxVGLizdceYa9Yz-iw0UGFipNmHzFkpX4VoEjBLnbYPQckyjms5R8z4DACLbNOKv6c5haAua1Q-S_UKZltr8zeppSD9PyBa18sbmx29jXpsVpevX9BAB" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve application-level log entries from Google Cloud Logging, filtered by institute. Supports pagination via `pageSize` query parameter." } }, "/jobTracker/v2/logs/spanId/{spanId}": { "get": { "tags": [ "Application Logs" ], "summary": "Get Logs by Span ID", "operationId": "get_logs_drill_down_by_span_id", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "spanId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The span ID identifier." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all log entries associated with a specific trace/span ID for debugging and request tracing." } }, "/instituteApp/v2/institute/{instituteId}/reportsv2/resume-score-list": { "post": { "tags": [ "Reporting" ], "summary": "Resume Score Report", "operationId": "post_resume_score_summary_per_student", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" }, "dateFilters": { "type": "array", "items": { "type": "string" } }, "scoreRange": { "type": "array", "items": { "type": "integer" } } }, "required": [ "offset", "limit", "dateFilters", "scoreRange" ] }, "example": { "offset": 0, "limit": 2, "dateFilters": [ "2025-01-01", "2025-08-01" ], "scoreRange": [ 0, 100 ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate a paginated report of student resumes with their scores and rankings. Pass filters and pagination in the request body. Supports Excel export." } }, "/instituteApp/v2/institute/{instituteId}/reportsv2/user-activity-list": { "post": { "tags": [ "Reporting" ], "summary": "User Activity Report", "operationId": "post_activity_performed_count_by_user_resume_jobs_contacts", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" }, "sortField": { "type": "string" }, "sortOrder": { "type": "string" }, "dateFilters": { "type": "array", "items": { "type": "string" } } }, "required": [ "offset", "limit", "sortField", "sortOrder", "dateFilters" ] }, "example": { "offset": 0, "limit": 1, "sortField": "lastActive", "sortOrder": "desc", "dateFilters": [ "2025-01-01", "2025-08-01" ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate a report of user activity counts across resumes, jobs, and contacts. Pass filters and pagination in the request body. Supports Excel export." } }, "/instituteApp/v2/institute/{instituteId}/reportsv2/features-job-tracking-data": { "post": { "tags": [ "Reporting" ], "summary": "Job Funnel Report", "operationId": "post_job_funnel_data_section_category", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" }, "dataType": { "type": "string" } }, "required": [ "startDate", "endDate", "dataType" ] }, "example": { "startDate": "2025-01-01", "endDate": "202508-01", "dataType": "funnel-health" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve job tracking funnel data showing counts by stage (saved, applied, interviewing, etc.). Pass filters in the request body. Supports Excel export." } }, "/instituteApp/v2/institute/{instituteId}/reportsv2/coaches-table-list": { "post": { "tags": [ "Reporting" ], "summary": "Coaches Report", "operationId": "post_coaches_list_with_filters", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" }, "dateFilters": { "type": "array", "items": { "type": "string" } }, "selectedStatus": { "type": "string" } }, "required": [ "offset", "limit", "dateFilters", "selectedStatus" ] }, "example": { "offset": 0, "limit": 20, "dateFilters": [ "2025-01-01", "2025-08-05" ], "selectedStatus": "" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate a report of coaches with their student counts and activity metrics. Pass filters and pagination in the request body. Supports Excel export." } }, "/instituteApp/v2/institute/{instituteId}/reportsv2/active-users-list": { "post": { "tags": [ "Reporting" ], "summary": "Active Students Report", "operationId": "post_job_seeker_list_with_filters", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The instituteId identifier." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" }, "dateFilters": { "type": "array", "items": { "type": "string" } } }, "required": [ "offset", "limit", "dateFilters" ] }, "example": { "offset": 0, "limit": 2, "dateFilters": [ "2025-01-01", "2025-08-01" ] } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Generate a report of active students with engagement metrics and filtering. Pass filters and pagination in the request body. Supports Excel export." } }, "/instituteApp/v2/institute/{instituteId}/checklists/all": { "get": { "tags": [ "Organization Administration" ], "summary": "List All Checklists", "operationId": "get_get_all_checklists_of_an_institute", "security": [ { "cf_api_key": [] } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve all checklists defined for the organization, including their nested items. Results are filtered by the caller's access scope.", "parameters": [ { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Institute ID. When using API key authentication, this is automatically resolved from the key — you can pass any value (e.g. `_`)." } ] } }, "/instituteApp/v2/institute/{instituteId}/checklist/{checklistId}/add-item": { "post": { "tags": [ "Organization Administration" ], "summary": "Add Checklist Item", "operationId": "post_checklist_item_creation", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "checklistId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The checklistId identifier." }, { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Institute ID. When using API key authentication, this is automatically resolved from the key — you can pass any value (e.g. `_`)." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "actionUrl": { "type": "string" }, "actionText": { "type": "string" } }, "required": [ "title", "description", "actionUrl", "actionText" ] }, "example": { "title": "LI Networking Outreach", "description": "Enter significant connections/notes into CRM for your own contacts", "actionUrl": "https://example.com/resources/networking-strategy", "actionText": "Networking strategy" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "OK" } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Add a new item to an existing checklist. Each item has a title, description, and optional action link." } }, "/instituteApp/v2/institute/{instituteId}/verifyInstituteCoach/{coachId}": { "get": { "tags": [ "Organization Administration" ], "summary": "Verify Coach", "operationId": "get_verify_coach", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "coachId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Coach ID or email address." }, { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Institute ID. When using API key authentication, this is automatically resolved from the key — you can pass any value (e.g. `_`)." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "boolean" }, "example": true } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Check whether a coach exists and is active within the organization by their email address." } }, "/instituteApp/v2/institute/{instituteId}/reInvite/{studentId}": { "post": { "tags": [ "Organization Administration" ], "summary": "Reinvite Student", "operationId": "post_reinvite_student", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "studentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Student ID or email address." }, { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Institute ID. When using API key authentication, this is automatically resolved from the key — you can pass any value (e.g. `_`)." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string" }, "email": { "type": "string" } }, "required": [ "firstName", "email" ] }, "example": { "firstName": "string", "email": "string" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_writeTime": { "type": "object", "properties": { "_seconds": { "type": "integer" }, "_nanoseconds": { "type": "integer" } }, "required": [ "_seconds", "_nanoseconds" ] } }, "required": [ "_writeTime" ] }, "example": { "_writeTime": { "_seconds": 0, "_nanoseconds": 0 } } } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Resend the invitation email to a student who has not yet accepted their invite." } }, "/instituteApp/v2/institute/{instituteId}/notes": { "get": { "tags": [ "Organization Administration" ], "summary": "List Private Notes", "operationId": "get_private_notes", "security": [ { "cf_api_key": [] } ], "parameters": [ { "name": "studentId", "in": "query", "required": false, "schema": { "type": "string" }, "example": "" }, { "name": "instituteId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Institute ID. When using API key authentication, this is automatically resolved from the key — you can pass any value (e.g. `_`)." } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [] } } }, "400": { "description": "Bad Request — invalid or missing parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid request parameters." } } } }, "403": { "description": "Forbidden — invalid, expired, or revoked API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Invalid api key." } } } }, "404": { "description": "Not Found — the requested resource does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The requested resource was not found." } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "An unexpected error occurred." } } } } }, "description": "Retrieve private notes for the organization. Optionally filter by `studentId` or `coachId` query parameter to get notes associated with a specific person." } }, "/instituteApp/v2/moveJob": { "put": { "tags": [ "Job Tracker" ], "summary": "Move Job Card to Column", "operationId": "put_move_job", "description": "Move a job card to a different column on the user's board. Column matching is case-insensitive. Moving to the same column is a no-op (returns 200). An activity log entry (JOB_MOVED) is created on success.", "security": [ { "cf_api_key": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jobId", "userId", "targetColumn" ], "properties": { "jobId": { "type": "string", "description": "The job card ID to move" }, "userId": { "type": "string", "description": "The userId of the student, coach, or admin who owns the board" }, "targetColumn": { "type": "string", "description": "The destination column name (case-insensitive). Examples: Saved, Applied, Interviewing, Offer, Rejected", "examples": [ "Applied", "Interviewing", "Saved" ] } } } } } }, "responses": { "200": { "description": "Job moved successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Job moved successfully" } } } } } }, "400": { "description": "Bad request — missing required fields or invalid column name. When the column is invalid, the response includes the list of valid column names.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Missing required fields: jobId, userId, targetColumn", "Target column \"InvalidColumn\" not found on this board. Valid columns: Saved, Applied, Interviewing, Offer, Rejected" ] } } } } } }, "403": { "description": "Forbidden — invalid or missing API key." }, "404": { "description": "Not found — user not in institute, no board found, or job card not on board.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "User not found in this institute", "No board found for this user", "Job card \"abc\" not found on this board" ] } } } } } }, "500": { "description": "Internal server error." } } } } }, "components": { "securitySchemes": { "cf_api_key": { "type": "apiKey", "in": "header", "name": "cf_api_key", "description": "Organization API key issued by Careerflow." } } } }