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

# Retrieves agency candidate settings

`GET /agency/{agency_id}/candidate/{candidate_id}/settings`

## Request

- Base URL: `http://localhost:3010/v1`
- URL: `http://localhost:3010/v1/agency/{agency_id}/candidate/{candidate_id}/settings`
- Auth: HTTP basic and HTTP basic and HTTP basic

## Response `200`

The settings of an agency candidate will be returned

- CandidateSettingsResponseWithAgencyGroups
  - `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

## Other responses

- `400`: Validation errors caused by missing or invalid header / path or payloads
- `401`: Failed to authenticate the user making the request
- `403`: Permission denied error
- `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.dev/staffshift/apis/staffshift-api-gateway/revisions/1f079f6b65f5?raw)