---
agentTools:
  projectIndex: https://qonexon.readme.io/llms.txt
---

# Get candidate by ID

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Qonexon API",
    "version": "1.0.0",
    "description": "This API provides access to Qonexon's job and candidate management system."
  },
  "components": {
    "schemas": {
      "candidate": {
        "type": "object",
        "description": "The candidate details.",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "The candidate's email address.",
            "example": "john.doe@example.com"
          },
          "first_name": {
            "type": "string",
            "description": "The candidate's first name.",
            "example": "John"
          },
          "last_name": {
            "type": "string",
            "description": "The candidate's last name.",
            "example": "Doe"
          },
          "phone": {
            "type": "string",
            "description": "The candidate's phone number.",
            "example": "+1 555-123-4567"
          },
          "company": {
            "type": "string",
            "description": "The candidate's current company.",
            "example": "XYZ Corp"
          },
          "title": {
            "type": "string",
            "description": "The candidate's current job title.",
            "example": "Software Engineer"
          },
          "location": {
            "type": "object",
            "description": "The candidate's location.",
            "properties": {
              "city": {
                "type": "string",
                "description": "The candidate's city.",
                "example": "New York"
              },
              "country": {
                "type": "string",
                "description": "The candidate's country.",
                "example": "USA"
              }
            }
          },
          "social_links": {
            "type": "array",
            "description": "The candidate's social media profiles.",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the social media platform.",
                  "example": "LinkedIn"
                },
                "url": {
                  "type": "string",
                  "format": "url",
                  "description": "The candidate's social media profile URL.",
                  "example": "https://www.linkedin.com/in/johndoe"
                }
              }
            }
          },
          "availability": {
            "type": "string",
            "description": "The candidate's availability for starting a new job.",
            "example": "2 weeks notice"
          },
          "skills": {
            "type": "array",
            "description": "The candidate's skills.",
            "items": {
              "type": "string",
              "example": "Python"
            }
          }
        },
        "required": [
          "email",
          "first_name"
        ]
      },
      "candidate_response": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "integer",
            "description": "The candidate's unique identifier."
          },
          "partner_candidate_id": {
            "type": "string",
            "description": "Partner's candidate identifier."
          },
          "partner_job_id": {
            "type": "string",
            "description": "Partner's job identifier."
          },
          "external_job_id": {
            "type": "string",
            "description": "External job identifier."
          },
          "candidate": {
            "$ref": "#/components/schemas/candidate"
          },
          "source": {
            "type": "string",
            "description": "The source of the candidate",
            "example": "Qonexon Job Board"
          },
          "applied_at": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when the candidate applied for the job.",
            "example": "2023-05-16T12:34:56Z"
          },
          "created_at": {
            "$ref": "#/components/schemas/created_at"
          },
          "updated_at": {
            "$ref": "#/components/schemas/updated_at"
          }
        }
      },
      "created_at": {
        "type": "string",
        "format": "date-time",
        "example": "2023-07-31T18:01:52.846564"
      },
      "updated_at": {
        "type": "string",
        "format": "date-time",
        "example": "2023-07-31T18:01:52.846564"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.qonexon.com"
    }
  ],
  "paths": {
    "/candidates/{id}": {
      "get": {
        "summary": "Get candidate by ID",
        "operationId": "getCandidate",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of the candidate to retrieve",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "integer"
            }
          },
          {
            "name": "company-reference",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "description": "ID of the company"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Candidate retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/candidate_response"
                }
              }
            }
          },
          "404": {
            "description": "Candidate not found"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 100,
      "1": 55,
      "2": 180,
      "3": 94,
      "4": 155,
      "5": 161,
      "6": 245,
      "7": 0,
      "8": 38,
      "9": 88,
      "10": 184,
      "11": 51
    }
  }
}
```