> ## Documentation Index
> Fetch the complete documentation index at: https://docs.harmonyforstaffing.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Candidate



## OpenAPI

````yaml GET /candidates
openapi: 3.0.0
info:
  title: Harmony AI Agents API
  version: 2.3.2
  description: API for interacting with Harmony AI Agents
servers: []
security: []
paths:
  /candidates:
    get:
      summary: Get candidates
      operationId: getCandidates
      parameters:
        - name: id
          in: query
          schema:
            type: string
          description: Filter by id
      responses:
        '200':
          description: Successfully retrieved candidate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Candidate'
                type: object
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
components:
  schemas:
    Candidate:
      type: object
      required:
        - id
        - firstName
        - lastName
        - email
        - statusId
        - dateAdded
      properties:
        id:
          type: integer
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phone:
          type: string
        address:
          $ref: '#/components/schemas/Address'
        notes:
          type: string
        profession:
          type: string
        specialty:
          type: string
        statusId:
          type: integer
          description: ID of the candidate's status
        status:
          $ref: '#/components/schemas/Status'
          description: Full status object
        dateAdded:
          type: integer
          description: Unix timestamp when the candidate was added
          format: int64
    Address:
      type: object
      properties:
        address1:
          type: string
          nullable: true
        address2:
          type: string
          nullable: true
        city:
          type: string
        countryCode:
          type: string
        state:
          type: string
        timezone:
          type: string
        zip:
          type: string
    Status:
      type: object
      required:
        - id
        - name
        - type
      properties:
        id:
          type: integer
          description: Unique identifier for the status
        name:
          type: string
          description: Name of the status
        type:
          type: string
          enum:
            - CANDIDATE
            - JOB
            - JOB_SUBMISSION
          description: Type of entity this status applies to
        description:
          type: string
          description: Description of what this status means
        isDefault:
          type: boolean
          description: Whether this is the default status for new entities
        isActive:
          type: boolean
          description: Whether this status is active

````