---
title: "Retrieves the schema for person profiles."
method: GET
path: "/dx/api/people/v1/schema"
tags: ["People / Schema"]
---

# Retrieves the schema for person profiles.

`GET /dx/api/people/v1/schema`

Provides extended information about the shape of user profiles and their attributes. 
    This includes metadata such as attribute behavior, default values, whether attributes are required, read-only, searchable, should be hidden from the UI, the type of the value, and more. 
    It can be used for dynamic form generation or validating user profile data client-side.

## Response `200`

Schema retrieval successful.

## Other responses

- `401` — Unauthorized. The request is missing a valid session.

## Changes

- **2025-03-19** `2267cfc94cf0` — 2 breaking
  - removed the media type `*/*` for the response with the status `200`
  - removed the media type `peopleSchemaExample` for the response with the status `200`
- **2025-03-19** `355f7332f550` — 2 info
  - added the media type `*/*` for the response with the status `200`
  - added the media type `peopleSchemaExample` for the response with the status `200`

[Change history](https://skmtc.dev/hcl-tech-software/apis/people-api-v1-server/changes/dx/api/people/v1/schema/get.md)

---

[API](https://skmtc.dev/hcl-tech-software/apis/people-api-v1-server.md) · [All operations](https://skmtc.dev/hcl-tech-software/apis/people-api-v1-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hcl-tech-software/people-api-v1-server/revisions/2267cfc94cf0/schema)