---
title: "List all candidates"
method: GET
path: "/ats/{connection_id}/candidate"
tags: ["ats", "candidate"]
---

# List all candidates

`GET /ats/{connection_id}/candidate`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/ats/{connection_id}/candidate`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

- `limit` number
- `offset` number
- `updated_gte` string, date-time
- `sort` 'name' | 'updated_at' | 'created_at'
- `order` 'asc' | 'desc'
- `query` string
- `company_id` string
- `job_id` string
- `fields` string[]
- `raw` string

## Response `200`

Successful

- AtsCandidate[]
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `name` string
  - `first_name` string
  - `last_name` string
  - `emails` AtsEmail[]
    - `name` string
    - `email` string, required
    - `type` 'WORK' | 'HOME' | 'OTHER'
  - `title` string: Candidate’s current job title
  - `telephones` AtsTelephone[]
    - `telephone` string, required
    - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
  - `company_name` string: Name of company where candidate currently works
  - `image_url` string
  - `tags` string[]
  - `address` AtsCandidateAddress
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string: Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province.
    - `region_code` string: Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province.
    - `postal_code` string
    - `country` string
    - `country_code` string: Country code for the country, in ISO 3166 A-2 format
  - `external_identifier` string
  - `link_urls` string[]: URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)
  - `origin` 'AGENCY' | 'APPLIED' | 'INTERNAL' | 'REFERRED' | 'SOURCED' | 'UNIVERSITY'
  - `company_id` string: (reference to AtsCompany)
  - `sources` string[]
  - `date_of_birth` string, date-time
  - `user_id` string: Employee ID that owns the relationship for this candidate (reference to HrisEmployee)
  - `user_ids` string[]: references hris employees
  - `web_url` string
  - `experiences` AtsCandidateExperience[]
    - `company_name` string
    - `title` string
    - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `education` AtsCandidateEducation[]
    - `institution` string
    - `level` string
    - `degree` string
    - `field_of_study` string
    - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `skills` string[]
  - `job_ids` string[]
  - `metadata` AtsMetadata[]
    - `id` string
    - `slug` string: Actual textual value of the slug
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `summary` string: Personal / professional bio
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)