# Get candidates

Creates list of Candidate with associated checks.

Endpoint: GET /candidates
Version: 1.0.0
Security: bearerAuth

## Response 200 fields (application/json):

  - `result` (object)

  - `result.candidates` (array)

  - `result.candidates.id` (integer)
    Example: 1

  - `result.candidates.reference_code` (string)
    Example: "whatever"

  - `result.candidates.first_name` (string)
    Example: "Luke"

  - `result.candidates.last_name` (string)
    Example: "Skywalker"

  - `result.candidates.name` (string)
    Example: "Luke Skywalker"

  - `result.candidates.email` (string)
    Example: "luke.skywalker@email.com"

  - `result.candidates.contact_number` (string)
    Example: "+6493614595"

  - `result.candidates.job_role` (string)
    Example: "Padawan"

  - `result.candidates.department` (string)
    Example: "Jedis"

  - `result.candidates.ip` (string,null)

  - `result.candidates.status` (string)
    Enum: "candidate", "submitted", "in-progress", "completed", "overdue", "canceled"

  - `result.candidates.token` (string)
    Example: "https://app.checkmate.tech/assessments/details/12/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N..."

  - `result.candidates.created_at` (string)
    Example: "2021-06-27T10:05:13+02:00"

  - `result.candidates.submitted_at` (string,null)

  - `result.candidates.completed_at` (string,null)

  - `result.candidates.accepted_terms_and_conditions` (boolean)

  - `result.candidates.partner_application_id` (string)
    Example: "your_unique_id"

  - `result.candidates.partner_application_started` (boolean)
    Example: true

  - `result.candidates.cc_notification_emails` (string)

  - `result.candidates.partner_link` (string)
    Example: "https://app.checkmate.tech/assessments/details/12/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N..."

  - `result.candidates.candidate_checks` (array)

  - `result.candidates.candidate_checks.type` (string)
    Example: "acc"

  - `result.candidates.candidate_checks.job_at` (string,null)

  - `result.candidates.candidate_checks.details` (object,null)

  - `result.candidates.candidate_checks.accepted_terms` (boolean)

  - `result.candidates.candidate_checks.result_flag` (boolean)

  - `result.candidates.candidate_checks.renewal` (boolean)

  - `result.candidates.candidate_checks.user_agent` (string,null)

  - `result.candidates.candidate_checks.upload` (object)

  - `result.candidates.candidate_checks.upload.file_name` (string)
    Example: "dummy_result.pdf"

  - `result.candidates.candidate_checks.upload.file_type` (string)
    Example: "application/pdf"

  - `result.candidates.candidate_checks.upload.url` (string)
    Expires after 20 minutes; refreshes on each request
    Example: "https://checkmate-staging.s3.ap-southeast-2.amazonaws.com/backg..."

  - `result.candidates.candidate_checks.expiration_date` (string,null)
    Example: "2024-10-23"

  - `result.candidates.candidate_checks_values` (object)

  - `result.candidates.candidate_checks_values.values` (object)

  - `result.pagination` (object)

  - `result.pagination.page` (integer)
    Example: 1

  - `result.pagination.records_per_page` (integer)
    Example: 15

  - `result.pagination.total_records` (integer)
    Example: 30

  - `result.pagination.total_pages` (integer)
    Example: 2

  - `error` (object,null)