---
title: "Check user field uniqueness"
method: GET
path: "/sdk/{environmentId}/users/check"
tags: ["SDK"]
---

# Check user field uniqueness

`GET /sdk/{environmentId}/users/check`

Check if the unique field value is already taken. For example, an enabled unique username or unique email. This also works with enabled unique custom fields.

## Path parameters

- `environmentId` string, required

## Query parameters

- `filter` UserFieldsCheckParams
  - `field` 'email' | 'username' | 'name-service-subdomain-handle', required
  - `value` string, required

## Response `200`

successful check

- UserFieldsCheckResponse
  - `field` string, required
  - `value` string, required
  - `available` boolean, required

## Other responses

- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity

---

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