---
title: "List custom data scopes"
method: GET
path: "/configuration/countries/{countryCode}/custom-scopes"
tags: ["configuration"]
---

# List custom data scopes

`GET /configuration/countries/{countryCode}/custom-scopes`

## Request

- Base URL: `https://api.smartrecruiters.com`
- URL: `https://api.smartrecruiters.com/configuration/countries/{countryCode}/custom-scopes`
- Auth: one of:
  - API key in header `x-smarttoken`
  - OAuth 2
    - Authorization code: `https://www.smartrecruiters.com/identity/oauth/allow`
    - Token URL: `https://api.smartrecruiters.com/identity/oauth/token` scopes: `configuration_read`

Returns country-specific overrides of custom data scopes for the given country code.

## Path parameters

- `countryCode` string, required

## Response `200`

List of custom scopes

- ListCustomScopesResponse
  - `scopes` CustomScopeResponse[]
    - `id` string, uuid, required
    - `countryCode` string, required
    - `status` 'ACTIVE' | 'DELETED', required
    - `name` string, required
    - `checkboxRequired` boolean, required
    - `translations` CustomScopeTranslation[], required
      - `language` string, required
      - `label` string, required

## Other responses

- `403`: Forbidden
- `409`: The company account must operate on separated consent model

---

[API](https://skmtc.dev/smartrecruiters/apis/configuration-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/configuration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/configuration-api/revisions/65491281a1a6?raw)