--- agentTools: projectIndex: https://devmatch.readme.io/llms.txt --- # Get a project by ID # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "DevMatch", "version": "1.0.0" }, "servers": [ { "url": "https://94s1zv81nb.execute-api.us-west-2.amazonaws.com", "description": "" } ], "paths": { "/api/projects/{id}": { "get": { "tags": [ "Projects" ], "parameters": [ { "name": "id", "description": "Id of the project to get", "schema": { "type": "integer" }, "in": "path", "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProject" } } }, "description": "The requested project." }, "404": { "description": "The project does not exist OR the current user does not have access to it" } }, "operationId": "getProject", "summary": "Get a project by ID" }, "parameters": [ { "name": "id", "schema": { "type": "integer" }, "in": "path", "required": true } ] } }, "components": { "schemas": { "Candidate": { "title": "Root Type for Candidate", "description": "A candidate that is not necesarily a user on DevMatch yet.", "type": "object", "properties": { "company_id": { "format": "int32", "type": "integer" }, "last_name": { "type": "string" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "phone_home": { "type": "string" }, "phone_cell": { "type": "string" }, "phone_work": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "source": { "type": "string" }, "date_available": { "type": "string" }, "can_relocate": { "format": "int32", "type": "integer" }, "notes": { "type": "string" }, "key_skills": { "type": "string" }, "current_employer": { "type": "string" }, "email1": { "type": "string" }, "email2": { "type": "string" }, "web_site": { "type": "string" }, "desired_pay": { "type": "string" }, "current_pay": { "type": "string" }, "best_time_to_call": { "type": "string" }, "databag": { "description": "Problem-specific data for this user in JSON format such as git repo URLs, etc.", "type": "string" }, "resume_url": { "description": "", "type": "string" }, "linkedin_url": { "description": "", "type": "string" }, "date_created": { "description": "", "type": "string" }, "date_modified": { "description": "", "type": "string" }, "calibration": { "description": "Whether or not this candidate has been flagged as a calibration candidate", "type": "integer" }, "candidate_id": { "description": "", "type": "number" }, "devmatch_user_id": { "description": "", "type": "string" }, "stage_id": { "description": "", "type": "number" }, "entered_by": { "description": "The DevMatch user id of the person who added this candidate to a project", "type": "string" }, "is_active": { "type": "integer" }, "owner": { "description": "", "type": "string" }, "project_id": { "description": "", "type": "integer" }, "is_hot": { "description": "", "type": "integer" } }, "example": { "company_id": 1, "last_name": "Gonzalez", "first_name": "Alan", "middle_name": "Jose", "phone_home": "(425) 555-5555", "phone_cell": "(425) 555-5555", "phone_work": "(425) 555-5555", "address": "123 Main St.", "city": "Bellevue", "state": "WA", "zip": "98011", "source": "LinkedIn", "date_available": "2022-11-26T01:32:59Z", "can_relocate": 0, "notes": "Some notes", "key_skills": "Azure, GCP, AWS", "current_employer": "Microsoft", "email1": "john@devmatch.io", "email2": "", "web_site": "", "is_hot": 1, "desired_pay": "$2,000", "current_pay": "$1,500", "best_time_to_call": "Evenings", "calibration": 0 } }, "Application": { "description": "", "type": "object", "properties": { "status": { "description": "", "type": "number" }, "logo_url": { "description": "", "type": "string" }, "company": { "description": "", "type": "string" }, "company_url": { "description": "", "type": "string" }, "job_position": { "description": "", "type": "string" }, "salary": { "description": "", "type": "string" }, "location": { "description": "", "type": "string" }, "short_description": { "description": "", "type": "string" }, "long_description": { "description": "", "type": "string" }, "id": { "description": "" }, "project_id": { "description": "", "type": "number" } } }, "ConfigurationKeyValuePair": { "title": "Root Type for ConfigurationKeyValuePair", "description": "", "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "example": { "name": "send-emails", "value": "true" } }, "GetProject": { "title": "Project Overview and Additional Details", "allOf": [ { "$ref": "#/components/schemas/Project" }, { "description": "Details about a single project with additional context like candidates and the funnel. More computationally-expensive." }, { "type": "object" }, { "required": [ "id", "name", "description", "state", "start_time", "end_time", "invite_token", "organization_id", "CandidateInvitationLink", "problems", "candidates", "testTakers", "funnel", "myResults", "configuration" ] }, { "properties": { "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "title": { "type": "string" }, "time_limit": { "format": "int32", "type": "integer" }, "skills": { "type": "string" } } } }, "invite_token": { "type": "string" }, "candidates": { "description": "All candidates added to this project", "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Candidate" } }, "CandidateInvitationLink": { "description": "A token that candidates can use to join this project.", "type": "string" }, "application": { "$ref": "#/components/schemas/Application", "description": "" }, "myResults": { "description": "" }, "funnel": { "description": "Data for rendering the candidate funnel graphic in the recruiter dashboard" }, "testTakers": { "description": "", "type": "array", "items": {} }, "configuration": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationKeyValuePair" } } } } ], "example": { "id": 102, "name": "10:29pm title 2", "description": "10:29pm desc", "state": "open", "start_time": "2022-11-05T05:29:00Z", "end_time": "2022-11-06T05:29:00Z", "problems": [ { "id": 99, "description": "row.description", "title": "row.title", "time_limit": 900, "skills": "row.skills" } ], "candidates": [ { "id": "123", "name": "John Doe", "email": "john@devmatch.io", "role": "user", "project_opened": 1, "project_opened_date": "2022-11-06T20:17:03Z", "last_login": "2022-11-06T20:17:03Z", "problems_started": 1 } ] } }, "Project": { "title": "Root Type for Project", "description": "A Project is a structure that facilitates candidates solving problems within a specified time limit. Projects may be used for take-home assessments, coding competitions, or live coding interviews.", "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "state": { "description": "Whether the project is \"open\" or \"closed\"", "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" }, "organization_id": { "description": "ID of the organization that this project belongs to, if any.", "type": "integer" } }, "example": { "id": 60, "name": "PPPPPROJECT", "description": "This is a new project", "state": "open", "start_time": "Apr 17, 2022 6:00 pm", "end_time": "Apr 17, 2022 8:00 pm" } } } }, "tags": [ { "name": "Projects", "description": "" } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 100, "1": 201, "2": 145, "3": 145, "4": 247, "5": 207, "6": 158, "7": 9, "8": 107, "9": 28, "10": 194, "11": 55 } } } ```