---
title: "List candidates"
method: GET
path: "/candidates"
tags: ["Candidates"]
---

# List candidates

`GET /candidates`

Returns a list of candidates. Uses cursor pagination.

## Query parameters

- `limit` integer
- `cursor` string
- `modifiedSince` string, date-time
- `modifiedUntil` string, date-time
- `listIds` string[]
- `include` string[], required

## Response `200`

Successfully retrieved candidates. Returns items array with pagination info containing cursor for the next page.

- GetCandidatesResponseDto
  - `items` CandidateListItemDto[], required
    - `id` string, required
    - `name` object, required
      - `viewType` 'candidateName', required
      - `avatarUrl` string, nullable, required
      - `firstName` string, required
      - `lastName` string, required
    - `gender` object, required
      - `viewType` 'candidateGender', required
      - `gender` 'male' | 'female' | 'x' | 'null', nullable, required
    - `nationality` object, required
      - `viewType` 'candidateNationality', required
      - `nationality` string[], required
    - `status` object, required
      - `viewType` 'candidateStatus', required
      - `status` string[], required
    - `emails` object, required
      - `viewType` 'candidateEmails', required
      - `emails` object[], required
        - `email` string, required
        - `purpose` 'personal' | 'work' | 'null', nullable, required
        - `isPrimary` boolean, required
    - `phoneNumbers` object, required
      - `viewType` 'candidatePhoneNumbers', required
      - `phoneNumbers` object[], required
        - `phoneNumber` string, required
        - `purpose` 'personal' | 'work' | 'null', nullable, required
        - `isPrimary` boolean, required
    - `locations` object, required
      - `viewType` 'candidateLocation', required
      - `locations` LocationDto[], required
        - `street1` string, nullable, required
        - `street2` string, nullable, required
        - `postalCode` string, nullable, required
        - `city` string, nullable, required
        - `region` string, nullable, required
        - `state` string, nullable, required
        - `country` string, nullable, required
        - `rawCityCountry` string, nullable, required
        - `latitude` number, nullable, required
        - `longitude` number, nullable, required
        - `formattedAddress` string, nullable, required
        - `type` 'primary_home' | 'secondary_home' | 'primary_work' | 'headquarters' | 'regional_office', required
    - `dateOfBirth` object, required
      - `viewType` 'candidateDateOfBirth', required
      - `dateOfBirth` string, date-time, required
    - `socialMedia` object, required
      - `viewType` 'candidateSocialMedia', required
      - `socialMedia` object[], required
        - `url` string, required
        - `type` 'LINKEDIN' | 'TWITTER' | 'FACEBOOK' | 'INSTAGRAM', required
        - `isPrimary` boolean, required
    - `lastInteractionDate` object, required
      - `viewType` 'candidateLastInteractionDate', required
      - `lastInteractionDate` string, date-time, required
    - `lastInteractionWith` object, required
      - `viewType` 'candidateLastInteractionWith', required
      - `user` UserDto, required
        - `userId` string, required
        - `name` string, required
        - `email` string, email, required
        - `avatarUrl` string, nullable, required
        - `deactivatedAt` string, date-time, required
    - `nextInteractionDate` object, required
      - `viewType` 'candidateNextInteractionDate', required
      - `nextInteractionDate` string, date-time, required
    - `nextInteractionWith` object, required
      - `viewType` 'candidateNextInteractionWith', required
      - `user` UserDto, required
        - `userId` string, required
        - `name` string, required
        - `email` string, email, required
        - `avatarUrl` string, nullable, required
        - `deactivatedAt` string, date-time, required
    - `mainContact` object, required
      - `viewType` 'candidateMainContact', required
      - `user` UserDto, required
        - `userId` string, required
        - `name` string, required
        - `email` string, email, required
        - `avatarUrl` string, nullable, required
        - `deactivatedAt` string, date-time, required
    - `languages` object, required
      - `viewType` 'candidateLanguages', required
      - `languages` LanguageDto[], required
        - `id` string
        - `language` 'Afrikaans' | 'Albanian' | 'Amharic' | 'Arabic' | 'Armenian' | 'Assamese' | 'Aymara' | 'Azerbaijani' | 'Bangla' | 'Basque' | 'Belarusian' | 'Bemba' | 'Berber' | 'Bislama' | 'Bosnian' | 'Bulgarian' | 'Burman' | 'Catalan' | 'Chechen' | 'Chewa' | 'Chinese (Mandarin)' | 'Chinese (Cantonese)' | 'Chittagonian' | 'Croatian' | 'Czech' | 'Danish' | 'Dari' | 'Dhivehi' | 'Dutch' | 'Dzongkha' | 'English' | 'Estonian' | 'Ewe' | 'Fijian' | 'Filipino' | 'Finnish' | 'French' | 'Galician' | 'Georgian' | 'German' | 'Greek' | 'Guarani' | 'Gujarati' | 'Haitian Creole' | 'Hausa' | 'Hebrew' | 'Hindi' | 'Hungarian' | 'Icelandic' | 'Igbo' | 'Indonesian' | 'Irish' | 'Italian' | 'Japanese' | 'Kannada' | 'Kazakh' | 'Khmer' | 'Kinyarwanda' | 'Kirundi' | 'Korean' | 'Kurdish' | 'Kyrgyz' | 'Lao' | 'Latvian' | 'Lingala' | 'Lithuanian' | 'Luganda' | 'Luxembourgish' | 'Macedonian' | 'Malagasy' | 'Malay' | 'Malayalam' | 'Maltese' | 'Maori' | 'Marathi' | 'Moldovan' | 'Mongolian' | 'Montenegrin' | 'Ndebele' | 'Nepali' | 'Norwegian' | 'Odia' | 'Oromo' | 'Pashto' | 'Persian' | 'Polish' | 'Portuguese' | 'Punjabi' | 'Quechua' | 'Romanian' | 'Russian' | 'Samoan' | 'Sango' | 'Serbian' | 'Sesotho' | 'Setswana' | 'Shona' | 'Sindhi' | 'Sinhala' | 'Slovak' | 'Slovenian' | 'Somali' | 'Spanish' | 'Swahili' | 'Swedish' | 'Tajik' | 'Tamil' | 'Telugu' | 'Tetum' | 'Thai' | 'Tigrinya' | 'Tok Pisin' | 'Tongan' | 'Tsonga' | 'Tswana' | 'Turkish' | 'Turkmen' | 'Ukrainian' | 'Urdu' | 'Uzbek' | 'Venda' | 'Vietnamese' | 'Welsh' | 'Xhosa' | 'Yoruba' | 'Zulu', required
        - `fluency` 'Elementary proficiency' | 'Limited working proficiency' | 'Professional working proficiency' | 'Full professional proficiency' | 'Native or bilingual proficiency', nullable
    - `compensation` object, required
      - `viewType` 'candidateCompensation', required
      - `compensation` CompensationDto, required
        - `id` string
        - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTC' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNH' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XCG' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL', required
        - `totalCompensation` number, nullable
        - `baseCompensation` number, nullable
    - `currentPlacements` object, required
      - `viewType` 'candidateCurrentPlacements', required
      - `hasCurrentPlacement` boolean, required
      - `placements` object[], required
        - `id` string, required
        - `company` object, required
          - `id` string, required
          - `name` string, required
          - `logoUrl` string, nullable, required
        - `startDate` string, date-time, required
        - `endDate` string, date-time, required
    - `nextTaskDue` object, required
      - `viewType` 'candidateNextTaskDue', required
      - `nextTaskDue` NextTaskDueDto, required
        - `id` string, required
        - `content` string, required
        - `dueDate` string, date-time, required
    - `createdAt` string, date-time, required
    - `modifiedAt` string, date-time, required
    - `lastActivityDate` string, date-time, required
    - `acquisitionSource` object, nullable, required
      - `viewType` 'candidateAcquisitionSource', required
      - `acquisitionSource` 'manual' | 'cv_parse' | 'inbound_vacancy_portal' | 'inbound_spontaneous_application' | 'chrome_extension_linkedin' | 'inbound_from_linkedin_jobboard_email' | 'inbound_from_external_jobboard' | 'juicebox' | 'pin' | 'maildrop' | 'csv_import' | 'vdab' | 'advertsdata' | 'null', nullable, required
    - `latestWorkExperience` WorkExperienceBadgeDto, required
      - `title` string, nullable, required
      - `company` CompanyBadgeDto, required
        - `id` string, required
        - `name` string, required
        - `logoUrl` string, nullable, required
    - `customAttributes` CustomAttributeItemDto[], required
      - `attributeDefinitionId` string, required
      - `label` string, required
      - `aiFillOngoing` boolean, required
      - `aiOverridden` boolean, required
      - `isFilledByAI` boolean, required
      - `value` union, required
        - object
          - `viewType` 'customText', required
          - `text` string, nullable, required
        - object
          - `viewType` 'customNumber', required
          - `number` number, nullable, required
        - object
          - `viewType` 'customCheckbox', required
          - `checked` boolean, nullable, required
        - object
          - `viewType` 'customDate', required
          - `date` string, date-time, required
        - object
          - `viewType` 'customTimestamp', required
          - `timestamp` string, date-time, required
        - object
          - `viewType` 'customRating', required
          - `rating` number, nullable, required
        - object
          - `viewType` 'customSelect', required
          - `select` string, nullable, required
        - object
          - `viewType` 'customMultiSelect', required
          - `multiSelect` string[], required
        - object
          - `viewType` 'customCurrency', required
          - `monetaryAmount` MonetaryAmountDto, required
            - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTC' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNH' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XCG' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL', required
            - `amount` number, required
        - object
          - `viewType` 'customDateRange', required
          - `dateRange` DateRangeDto, required
            - `startDate` string, date-time, required
            - `endDate` string, date-time, required
        - object
          - `viewType` 'customDuration', required
          - `duration` number, nullable, required
        - object
          - `viewType` 'customUrl', required
          - `url` string, nullable, required
        - object
          - `viewType` 'customEntity', required
          - `type` 'user', required
          - `id` string, nullable, required
          - `entity` UserBadgeDto
            - `id` string, required
            - `name` string, required
            - `avatarUrl` string, nullable, required
            - `deactivatedAt` string, date-time, required
        - object
          - `viewType` 'customMultiEntity', required
          - `type` 'user', required
          - `ids` string[], required
          - `entities` UserBadgeDto[]
            - `id` string, required
            - `name` string, required
            - `avatarUrl` string, nullable, required
            - `deactivatedAt` string, date-time, required
    - `aiSummary` string, nullable, required
    - `isVisibleIfClientContact` boolean, nullable, required
    - `skills` SkillBadgeDto[]
      - `id` string, required
      - `name` string, required
    - `hasClientContacts` boolean, required
  - `pageInfo` CursorPageInfoDto, required
    - `nextCursor` string, nullable, required — Deprecated: use pagination.cursor instead.
    - `hasNextPage` boolean, required — Deprecated: use the presence of pagination.cursor instead.

## Other responses

- `400` — Bad request - invalid query parameters (e.g., limit out of range, invalid date format)
- `401` — Unauthorized - invalid or missing authentication
- `500` — Error response

---

[API](https://skmtc.net/spott/apis/spott-webhooks.md) · [All operations](https://skmtc.net/spott/apis/spott-webhooks/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spott/spott-webhooks/versions/ad1f8c51cf0a/schema)