# Retrieve a page of anonymised candidates in a saved list

Fetches a paginated array of anonymised candidates belonging to a specific saved list, identified by its public ID.

Endpoint: GET /v1/candidates/by-list/{publicListId}
Version: 1.0.0
Security: ApiKeyAuth

## Path parameters:

  - `publicListId` (string, required)
    The public ID of the saved list

## Query parameters:

  - `page` (integer)
    The page number for pagination

  - `limit` (integer)
    The number of results per page

## Response 200 fields (application/json):

  - `content` (array)

  - `content.candidateCertifications` (array)
    List of certifications held by the candidate.

  - `content.candidateCertifications.name` (string, required)
    The name of the certification.
    Example: "Certified Kubernetes Administrator"

  - `content.candidateCertifications.institution` (string, required)
    The authority that issued the certification.
    Example: "Cloud Native Computing Foundation"

  - `content.candidateCertifications.dateCompleted` (string, required)
    The date the certification was achieved.
    Example: "2024-11-27"

  - `content.candidateCitizenships` (array)
    List of citizenships held by the candidate.

  - `content.candidateCitizenships.hasPassport` (string)
    Whether the candidate has a passport.
    Enum: "NO_RESPONSE", "VALID_PASSPORT", "INVALID_PASSPORT", "NO_PASSPORT"

  - `content.candidateCitizenships.passportExp` (string)
    The expiration date of the candidate's passport.
    Example: "2024-11-27"

  - `content.candidateCitizenships.nationality` (object)

  - `content.candidateCitizenships.nationality.isoCode` (string, required)
    The ISO 3166-1 alpha-2 code for the country.
    Example: "GB"

  - `content.candidateCitizenships.nationality.name` (string, required)
    The name of the country.
    Example: "United Kingdom"

  - `content.candidateCitizenships.nationality.status` (string, required)
    The status of the country.
    Enum: "ACTIVE", "INACTIVE", "DELETED"

  - `content.candidateDestinations` (array)
    List of destinations related to the candidate.

  - `content.candidateDestinations.country` (object)
    The country of the destination.

  - `content.candidateDestinations.interest` (string)
    The candidate's interest in the destination.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.candidateEducations` (array)
    List of educational achievements of the candidate.

  - `content.candidateEducations.educationType` (string)
    The type of education.
    Enum: "ASSOCIATE", "VOCATIONAL", "BACHELOR", "MASTERS", "DOCTORAL"

  - `content.candidateEducations.country` (object)

  - `content.candidateEducations.educationMajor` (object)
    The major of the education.

  - `content.candidateEducations.educationMajor.id` (integer)
    The unique identifier for the education major.
    Example: 8713

  - `content.candidateEducations.educationMajor.iscedCode` (string)
    The ISCED code for the education major.
    Example: "0711"

  - `content.candidateEducations.educationMajor.name` (string)
    The name of the education major.
    Example: "Computer Science"

  - `content.candidateEducations.educationMajor.status` (string)
    The status of the education major.
    Enum: "ACTIVE", "INACTIVE", "DELETED"

  - `content.candidateEducations.lengthOfCourseYears` (integer)
    The length of the course in years.
    Example: 4

  - `content.candidateEducations.institution` (string)
    The institution where the education was completed.
    Example: "University of Cambridge"

  - `content.candidateEducations.courseName` (string)
    The name of the course.
    Example: "Computer Science Tripos"

  - `content.candidateEducations.yearCompleted` (integer)
    The year the education was completed.
    Example: 2024

  - `content.candidateEducations.incomplete` (boolean)
    Whether the education was completed.

  - `content.candidateExams` (array)
    List of exams taken by the candidate.

  - `content.candidateExams.exam` (string)
    The type of the exam.
    Enum: "NO_RESPONSE", "OET", "OET_READ", "OET_LIST", "OET_LANG", "IELTS_GEN", "IELTS_ACA", "TOEFL", "OTHER", "DET_OFFICIAL"

  - `content.candidateExams.otherExam` (string)
    The name of the exam if the exam type is "Other".
    Example: "Test of English for Aviation"

  - `content.candidateExams.score` (string)
    The score of the exam.
    Example: "8.5"

  - `content.candidateExams.year` (integer)
    The year the exam was taken.
    Example: 2024

  - `content.candidateLanguages` (array)
    List of languages that the candidate is proficient in.

  - `content.candidateLanguages.language` (object)
    The language that the candidate is proficient in.

  - `content.candidateLanguages.language.isoCode` (string)
    The ISO code for the language.
    Example: "en"

  - `content.candidateLanguages.language.name` (string)
    The name of the language.
    Example: "English"

  - `content.candidateLanguages.language.status` (string)
    The status of the language.
    Enum: "ACTIVE", "INACTIVE", "DELETED"

  - `content.candidateLanguages.writtenLevel` (object)
    The candidate's written proficiency in this language.

  - `content.candidateLanguages.writtenLevel.level` (integer)
    The language proficiency level id.
    Example: 351

  - `content.candidateLanguages.writtenLevel.name` (string)
    The name of the language proficiency level.
    Example: "Full Professional Proficiency"

  - `content.candidateLanguages.writtenLevel.cefrLevel` (string)
    The CEFR code for the language proficiency level.
    Enum: "A1", "A2", "B1", "B2", "C1", "C2"

  - `content.candidateLanguages.spokenLevel` (object)
    The candidate's spoken proficiency in this language.

  - `content.candidateMessage` (string)
    Message written by the candidate.

  - `content.candidateOccupations` (array)
    List of occupations related to the candidate.

  - `content.candidateOccupations.occupation` (object)
    The candidate's occupation.

  - `content.candidateOccupations.occupation.isco08Code` (string)
    The ISCO-08 code for the occupation.
    Example: "2411"

  - `content.candidateOccupations.occupation.name` (string)
    The name of the occupation.
    Example: "Accountant"

  - `content.candidateOccupations.occupation.status` (string)
    The status of the occupation.
    Enum: "ACTIVE", "INACTIVE", "DELETED"

  - `content.candidateOccupations.yearsExperience` (integer)
    The number of years of experience the candidate has in this job.
    Example: 5

  - `content.candidateOccupations.candidateJobExperiences` (array)
    List of job experiences of the candidate in this occupation.

  - `content.candidateOccupations.candidateJobExperiences.companyName` (string)
    The name of the company where the candidate worked.
    Example: "Acme Corporation"

  - `content.candidateOccupations.candidateJobExperiences.role` (string)
    The role the candidate had at the company.
    Example: "Senior Software Engineer"

  - `content.candidateOccupations.candidateJobExperiences.startDate` (string)
    The date the candidate started working at the company.
    Example: "2020-11-27"

  - `content.candidateOccupations.candidateJobExperiences.endDate` (string)
    The date the candidate stopped working at the company.
    Example: "2024-11-27"

  - `content.candidateOccupations.candidateJobExperiences.fullTime` (boolean)
    Whether the candidate worked full-time at the company.
    Example: true

  - `content.candidateOccupations.candidateJobExperiences.paid` (boolean)
    Whether the candidate was paid for their work at the company.
    Example: true

  - `content.candidateOccupations.candidateJobExperiences.description` (string)
    A description of the candidate's work at the company.
    Example: "Developed new features for the company's flagship product."

  - `content.candidateSkills` (array)
    List of skills possessed by the candidate.

  - `content.candidateSkills.skill` (string)
    The name of the skill.
    Example: "Java"

  - `content.candidateSkills.timePeriod` (string)
    The duration the candidate has been using this skill.
    Example: "5 years"

  - `content.city` (string)
    City of residence
    Example: "Amman"

  - `content.contactConsentTcPartners` (boolean)
    Indicates whether the candidate has given consent to be contacted by TC partners.
    Example: true

  - `content.contactConsentRegistration` (boolean)
    Indicates whether the candidate has given consent to be contacted regarding their registration and employment opportunities.
    Example: true

  - `content.country` (object)
    Country where candidate is currently located

  - `content.gender` (string)
    Candidate's gender.
    Enum: "MALE", "FEMALE", "OTHER"

  - `content.maxEducationLevel` (object)
    The maximum education level of the candidate

  - `content.maxEducationLevel.level` (integer)
    The level of education.
    Example: 40

  - `content.maxEducationLevel.status` (string)
    The status of the education level.
    Enum: "ACTIVE", "INACTIVE", "DELETED"

  - `content.nationality` (object)
    Nationality of the candidate.

  - `content.howHeardAboutUs` (string)
    How the candidate heard about the Talent Catalog.
    Enum: "ONLINE_GOOGLE_SEARCH", "FACEBOOK", "INSTAGRAM", "LINKEDIN", "X", "WHATSAPP", "YOUTUBE", "FRIEND_COLLEAGUE_REFERRAL", "UNIVERSITY_SCHOOL_REFERRAL", "EMPLOYER_REFERRAL", "EVENT_WEBINAR", "INFORMATION_SESSION", "COMMUNITY_CENTRE_POSTING_FLYERS", "OUTREACH_WORKER", "NGO", "UNHCR", "US_AFGHAN", "ULYP", "TECHFUGEES", "AL_GHURAIR_FOUNDATION", "OTHER"

  - `content.unhcrConsent` (string)
    Indicates whether the candidate has given consent for UNHCR to be notified that they have registered on the Talent Catalog.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.yearOfArrival` (integer)
    Year of arrival in the country
    Example: 2010

  - `content.publicId` (string, required)
    Universally unique identifier for the candidate
    Example: "ABcd2EFgHIjkLMNOp3QR-S"

  - `content.asylumYear` (string)
    Date of asylum
    Example: "2015-07-12"

  - `content.arrestImprison` (string)
    Indicates whether the candidate has been arrested or imprisoned.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.availDate` (string)
    Date when the candidate becomes available for opportunities. A date without a time-zone in the ISO-8601 calendar system
    Example: "2023-12-01"

  - `content.availImmediate` (string)
    Indicates whether the candidate is immediately available for opportunities.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.availImmediateJobOps` (string)
    The type of job opportunities the candidate is qualified for.
    Example: "Yes"

  - `content.availImmediateReason` (string)
    Reason for the candidate's immediate availability.
    Enum: "FAMILY", "HEALTH", "CURRENT_WORK", "STUDIES", "OTHER"

  - `content.birthCountry` (object)
    Country of birth

  - `content.candidateDependants` (array)
    List of dependants related to the candidate.

  - `content.candidateDependants.relation` (string)
    The relation of the dependant to the candidate.
    Enum: "NO_RESPONSE", "PARTNER", "CHILD", "PARENT", "SIBLING", "AUNT_UNCLE", "GRANDPARENT", "COUSIN", "OTHER"

  - `content.candidateDependants.relationOther` (string)
    The relation of the dependant to the candidate if the relation is "Other".
    Example: "Niece"

  - `content.candidateDependants.yearOfBirth` (integer)
    Year of birth of the candidate
    Example: 1985

  - `content.candidateDependants.gender` (string)
    The gender of the dependant.
    Enum: "MALE", "FEMALE", "OTHER"

  - `content.candidateDependants.registered` (string)
    Whether and where the dependant is registered.
    Enum: "NO_RESPONSE", "UNHCR", "UNRWA", "NEITHER", "NA"

  - `content.candidateDependants.healthConcern` (string)
    Any health concerns for the dependant.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks` (array)
    List of visa checks related to the candidate.

  - `content.candidateVisaChecks.country` (object)
    The country of the visa.

  - `content.candidateVisaChecks.protection` (string)
    Meets international protection assessment.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.englishThreshold` (string)
    Meets the English language threshold for the visa.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.healthAssessment` (string)
    Meets health assessment for the visa.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.characterAssessment` (string)
    Meets character assessment for the visa.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.securityRisk` (string)
    Meets security risk assessment for the visa.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.overallRisk` (string)
    The overall risk assessment status for the visa.
    Enum: "NO_RESPONSE", "LOW", "MEDIUM", "HIGH"

  - `content.candidateVisaChecks.validTravelDocs` (string)
    The validity status of the candidate's travel document (if exists).
    Enum: "NO_RESPONSE", "VALID", "EXPIRED", "NONE"

  - `content.candidateVisaChecks.pathwayAssessment` (string)
    Meets pathway assessment for the visa.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.candidateVisaChecks.destinationFamily` (string)
    The closest relative of the candidate in the destination country (if exists).
    Enum: "NO_RESPONSE", "NO_RELATION", "CHILD", "PARENT", "SIBLING", "AUNT_UNCLE", "GRANDPARENT", "COUSIN", "OTHER"

  - `content.candidateVisaChecks.candidateVisaJobChecks` (array)
    The job checks for the candidate's visa.

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp` (object)
    The job opportunity that's located in same destination associated with the visa check.

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.country` (object)
    The country where the job opportunity is located.

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.employerEntity` (object)
    The anonymised employer details.

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.employerEntity.country` (object)
    The country where the employer is located.

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.employerEntity.hasHiredInternationally` (boolean)
    Whether the employer has hired internationally.
    Example: true

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.evergreen` (boolean)
    Whether the job opportunity is evergreen.
    Example: true

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.publishedDate` (string)
    The date the job opportunity was published.
    Example: "2021-01-01T00:00:00Z"

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.stage` (string)
    The stage of the job opportunity.
    Enum: "PROSPECT", "BRIEFING", "PITCHING", "MOU", "IDENTIFYING_ROLES", "CANDIDATE_SEARCH", "VISA_ELIGIBILITY", "CV_PREPARATION", "CV_REVIEW", "RECRUITMENT_PROCESS", "JOB_OFFER", "TRAINING", "VISA_PREPARATION", "POST_HIRE_ENGAGEMENT", "HIRING_COMPLETED", "INELIGIBLE_EMPLOYER", "INELIGIBLE_OCCUPATION", "INELIGIBLE_REGION", "NO_INTEREST", "NO_JOB_OFFER", "NO_PR_PATHWAY", "NO_SUITABLE_CANDIDATES", "NO_VISA", "TOO_EXPENSIVE", "TOO_HIGH_WAGE", "TOO_LONG", "MOU_ISSUE", "TRAINING_NOT_COMPLETED"

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.submissionDueDate` (string)
    The date submissions are due for the job opportunity.
    Example: "2021-01-01"

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.hiringCommitment` (integer)
    The number of candidates the employer has committed to hiring for this opportunity.
    Example: 3

  - `content.candidateVisaChecks.candidateVisaJobChecks.jobOpp.employerHiredInternationally` (string)
    Whether the employer had hired internationally prior to this opportunity.
    Example: "Yes"

  - `content.candidateVisaChecks.candidateVisaJobChecks.interest` (string)
    The candidate has genuine interest and desire to relocate for the job opportunity.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.candidateVisaJobChecks.qualification` (string)
    The candidate has relevant qualification for the job opportunity.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.candidateVisaJobChecks.occupation` (object)
    The occupation for the job opportunity.

  - `content.candidateVisaChecks.candidateVisaJobChecks.salaryTsmit` (string)
    The salary for the job opportunity meets the TSMIT threshold (Australia visa check ONLY), see 'https://www.homeaffairs.gov.au/reports-and-pubs/files/tsmit_review_report.pdf'
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.candidateVisaJobChecks.regional` (string)
    The job opportunity is in a regional area.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.candidateVisaJobChecks.eligible_494` (string)
    The candidate is eligible for the 494 visa (Australia visa check ONLY).
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.candidateVisaJobChecks.eligible_186` (string)
    The candidate is eligible for the 186 visa.(Australia visa check ONLY)
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.candidateVisaChecks.candidateVisaJobChecks.eligibleOther` (string)
    The candidate is eligible for another visa (Australia visa check ONLY).
    Enum: "NO_RESPONSE", "TEMP_SKILLED", "SPECIAL_HUM", "OTHER_HUM", "DIRECT_ENT", "POINTS_INDEP"

  - `content.candidateVisaChecks.candidateVisaJobChecks.putForward` (string)
    The candidate has been put forward for the job opportunity.
    Enum: "NO_RESPONSE", "YES", "YES_BUT", "DISCUSS_FURTHER", "SEEK_ADVICE", "NO"

  - `content.candidateVisaChecks.candidateVisaJobChecks.tcEligibility` (string)
    The candidate is eligible for the Talent Catalog.
    Enum: "NO_RESPONSE", "PROCEED", "DISCUSS", "DONT_PROCEED"

  - `content.candidateVisaChecks.candidateVisaJobChecks.ageRequirement` (string)
    The candidate meets the age requirement for the job opportunity.
    Example: "Yes"

  - `content.candidateVisaChecks.candidateVisaJobChecks.languagesRequired` (array)
    An array of language IDs denoting the languages required for the job opportunity.
    Example: [1,2]

  - `content.candidateVisaChecks.candidateVisaJobChecks.languagesThresholdMet` (string)
    The candidate meets the language threshold for the job opportunity.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.canDrive` (string)
    Indicates whether the candidate can drive.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.conflict` (string)
    Indicates whether the candidate has participated in a conflict.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.covidVaccinated` (string)
    Vaccination status of the candidate.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.covidVaccinatedDate` (string)
    Date of the candidate's last COVID-19 vaccination.
    Example: "2022-12-15"

  - `content.covidVaccineName` (string)
    Name of the COVID-19 vaccine received by the candidate.
    Example: "Pfizer-BioNTech"

  - `content.covidVaccinatedStatus` (string)
    COVID-19 vaccination status of the candidate.
    Enum: "NO_RESPONSE", "FULL", "PARTIAL"

  - `content.crimeConvict` (string)
    Indicates whether the candidate has a criminal conviction.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.destLimit` (string)
    Destination limits for the candidate.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.drivingLicense` (string)
    Indicates the status of the candidate's driving license.
    Enum: "NO_RESPONSE", "VALID", "EXPIRED", "NONE"

  - `content.drivingLicenseCountry` (object)
    Country where the candidate's driving license was issued.

  - `content.drivingLicenseExp` (string)
    Expiry date of the candidate's driving license.
    Example: "2025-12-31"

  - `content.englishAssessmentScoreIelts` (string)
    IELTS score of the candidate's English assessment.
    Example: "6.5"

  - `content.familyMove` (string)
    Indicates whether the candidate is moving with their family.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.frenchAssessmentScoreNclc` (integer)
    NCLC (Canadian Language Benchmark) score of the candidate's French assessment.
    Example: 10

  - `content.fullIntakeCompletedDate` (string)
    Date when the full intake was completed.
    Example: "2022-12-31T14:30:00Z"

  - `content.healthIssues` (string)
    Indicates whether the candidate has health issues.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.homeLocation` (string)
    Home location of the candidate before they became a refugee.
    Example: "Damascus"

  - `content.hostChallenges` (string)
    Challenges faced by the candidate in the host country.
    Example: "Host country challenges"

  - `content.hostEntryLegally` (string)
    Indicates if the candidate entered the host country legally.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.hostEntryYear` (integer)
    Year the candidate entered the host country.
    Example: 2010

  - `content.ieltsScore` (number)
    IELTS score of the candidate.
    Example: 7.5

  - `content.intRecruitReasons` (array)
    Reasons for the candidate's international recruitment.
    Enum: "NO_RESPONSE", "CANT_RETURN_HOME", "CITIZENSHIP", "EXPERIENCE", "CHILDREN", "OTHER"

  - `content.intRecruitRural` (string)
    Indicates whether the candidate will work in a rural area.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.leftHomeReasons` (array)
    Reasons for the candidate leaving home.
    Enum: "NO_RESPONSE", "SAFETY", "JOB", "OTHER"

  - `content.maritalStatus` (string)
    Marital status of the candidate.
    Enum: "NO_RESPONSE", "MARRIED", "ENGAGED", "DEFACTO", "SINGLE", "DIVORCED", "SEPARATED", "WIDOWER"

  - `content.mediaWillingness` (string)
    Indicates the candidate's willingness to participate in media activities
    Example: "Yes"

  - `content.militaryService` (string)
    Indicates whether the candidate has served in the military.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.militaryWanted` (string)
    Indicates whether the candidate is wanted for military service.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.militaryStart` (string)
    Start date of the candidate's military service.
    Example: "2010-01-01"

  - `content.militaryEnd` (string)
    End date of the candidate's military service.
    Example: "2015-01-01"

  - `content.miniIntakeCompletedDate` (string)
    Date when the mini intake was completed.
    Example: "2022-12-31T14:30:00Z"

  - `content.monitoringEvaluationConsent` (string)
    Indicates whether the candidate has given consent for monitoring and evaluation.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.numberDependants` (integer)
    Number of dependants related to the candidate.
    Example: 2

  - `content.partnerRegistered` (string)
    Indicates whether the candidate's partner is registered.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.partnerPublicId` (string)
    Anonymised public ID of the candidate's partner (if also a candidate in the system)
    Example: "ABcd2EFgHIjkLMNOp3QR-S"

  - `content.partnerCitizenship` (array)
    Citizenship(s) of the candidate's partner.
    Example: [1,2]

  - `content.partnerEduLevel` (object)
    Education level of the candidate's partner.

  - `content.partnerEnglish` (string)
    Indicates whether the candidate's partner speaks English.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.partnerEnglishLevel` (object)
    English proficiency level of the candidate's partner.

  - `content.partnerIelts` (string)
    Indicates whether the candidate's partner has taken the IELTS exam.
    Enum: "NO_RESPONSE", "YES_GENERAL", "YES_ACADEMIC", "NO", "UNSURE"

  - `content.partnerIeltsScore` (string)
    IELTS score of the candidate's partner.
    Example: "7.5"

  - `content.partnerIeltsYr` (integer)
    Year the candidate's partner took the IELTS exam.
    Example: 2020

  - `content.partnerOccupation` (object)
    Occupation of the candidate's partner.

  - `content.residenceStatus` (string)
    Residence status of the candidate.
    Enum: "NO_RESPONSE", "LEGAL_RES", "ILLEGAL_RES", "OTHER"

  - `content.returnedHome` (string)
    Indicates whether the candidate has returned home.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.returnHomeSafe` (string)
    Indicates whether the candidate returned home safely.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.returnHomeFuture` (string)
    Indicates whether the candidate plans to return home in the future.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.resettleThird` (string)
    Indicates whether the candidate has ever applied for resettlement or emigration to a 3rd country.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.status` (string)
    Status of the candidate.
    Enum: "ACTIVE", "AUTONOMOUS_EMPLOYMENT", "DELETED", "DRAFT", "EMPLOYED", "INCOMPLETE", "INELIGIBLE", "PENDING", "UNREACHABLE", "WITHDRAWN"

  - `content.unhcrNotRegStatus` (string)
    UNHCR not registered status of the candidate.
    Enum: "NO_RESPONSE", "WAS_REGISTERED", "NEVER_REGISTERED", "REGISTERING", "UNSURE", "NA"

  - `content.unhcrRegistered` (string)
    Indicates whether the candidate is registered with UNHCR.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.unhcrStatus` (string)
    UNHCR status of the candidate.
    Enum: "NO_RESPONSE", "MANDATE_REFUGEE", "REGISTERED_ASYLUM", "REGISTERED_STATELESS", "REGISTERED_STATUS_UNKNOWN", "NOT_REGISTERED", "UNSURE", "NA"

  - `content.unrwaNotRegStatus` (string)
    UNRWA not registered status of the candidate.
    Enum: "NO_RESPONSE", "WAS_REGISTERED", "NEVER_REGISTERED", "REGISTERING", "UNSURE", "NA"

  - `content.unrwaRegistered` (string)
    Indicates whether the candidate is registered with UNRWA.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.visaIssues` (string)
    Indicates whether the candidate has had visa issues.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.visaReject` (string)
    Indicates whether the candidate has had a visa application rejected.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.workAbroad` (string)
    Indicates whether the candidate has worked abroad.
    Enum: "NO_RESPONSE", "YES", "NO"

  - `content.workPermit` (string)
    Indicates whether the candidate has a work permit and if it is in the desired field.
    Enum: "NO_RESPONSE", "YES_NOT_DESIRED", "YES_DESIRED", "NO"

  - `content.workPermitDesired` (string)
    Indicates whether the candidate desires a work permit.
    Enum: "NO_RESPONSE", "YES", "NO", "UNSURE"

  - `content.createdDate` (string)
    Date when the candidate was created.
    Example: "2024-11-14T14:30:00Z"

  - `totalElements` (integer)

  - `totalPages` (integer)

  - `size` (integer)

  - `number` (integer)

## Response 400 fields (application/problem+json):

  - `type` (string)
    A URI reference that identifies the problem type with a link to human-readable  documentation for the error.
    Example: "https://example.com/probs/doc"

  - `title` (string)
    A short, human-readable summary of the problem type that does not change from occurrence to  occurrence of the problem.
    Example: "Invalid Request"

  - `status` (integer)
    The HTTP status code generated by the origin server for this occurrence of the problem.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A request parameter is invalid."

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem. It may be used to  provide further context.
    Example: "/v1/candidates?page=1"

## Response 401 fields (application/problem+json):

  - `type` (string)
    A URI reference that identifies the problem type with a link to human-readable  documentation for the error.
    Example: "https://example.com/probs/doc"

  - `title` (string)
    A short, human-readable summary of the problem type that does not change from occurrence to  occurrence of the problem.
    Example: "Authentication required"

  - `status` (integer)
    The HTTP status code generated by the origin server for this occurrence of the problem.
    Example: 401

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "Invalid API key."

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem. It may be used to  provide further context.
    Example: "/v1/candidates?page=1"

## Response 500 fields (application/problem+json):

  - `type` (string)
    A URI reference that identifies the problem type with a link to human-readable  documentation for the error.
    Example: "https://example.com/probs/doc"

  - `title` (string)
    A short, human-readable summary of the problem type that does not change from occurrence to  occurrence of the problem.
    Example: "Service Unavailable"

  - `status` (integer)
    The HTTP status code generated by the origin server for this occurrence of the problem.
    Example: 500

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "An unexpected error occurred. Please try again later."

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem. It may be used to  provide further context.
    Example: "/v1/candidates?page=1"