Sign in
People / Schema

Retrieves the schema for person profiles.

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.

get/dx/api/people/v1/schema

Response

Schema retrieval successful.

Changes

Changed in 2 of the 3 revisions of this API.22

  • 2267cfc94cf02See the full diff
    • ▲

      removed the media type */* for the response with the status 200

      response-media-type-removed

    • ▲

      removed the media type peopleSchemaExample for the response with the status 200

      response-media-type-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 355f7332f5502See the full diff
    • ○

      added the media type */* for the response with the status 200

      response-media-type-added

    • ○

      added the media type peopleSchemaExample for the response with the status 200

      response-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog