---
title: "Retrieves candidate settings"
method: GET
path: "/candidate/{candidate_id}/settings"
tags: ["Candidate Settings"]
---

# Retrieves candidate settings

`GET /candidate/{candidate_id}/settings`

## Response `200`

The settings of a candidate will be returned

- CandidateSettingsResponseWithAgencyGroupsAndAgencies
  - `candidate_id` string, required — The id of the candidate
  - `profile_editable` boolean, required — Set profile editable or not for candidate
  - `user_status` 'active' | 'inactive' | 'awaiting_verification' | 'gdpr_revoked'
  - `invitation_status` 'used' | 'not_used'
  - `employment_history_editable` boolean, required
  - `employment_skills_editable` boolean, required
  - `professional_registration_editable` boolean, required
  - `professional_reference_editable` boolean, required
  - `available_shifts_enabled` boolean
  - `agency_groups` object[]
    - `agency_group_id` string, required
    - `candidate_type` string, required
    - `candidate_status` string
    - `display_name` string
    - `avatar_url` string
    - `country_code` string — The country code
  - `agencies` object[]
    - `display_name` string, required
    - `avatar_url` string
    - `agency_id` string, required

## Other responses

- `400` — Validation errors caused by missing or invalid header / path or payloads
- `401` — Failed to authenticate the user making the request
- `404` — Resource not found
- `default` — Server error occurred

---

[API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) · [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/staffshift/staffshift-api-gateway/revisions/6e2cb83db3a9/schema)
