---
title: "Get full schema"
method: GET
path: "/api/storage/profile-system/schemas/profileSystem"
tags: ["Schemas"]
---

# Get full schema

`GET /api/storage/profile-system/schemas/profileSystem`

Retrieves the full profile schema, including custom fields.


Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.

>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.
>
> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). 

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Profile System | Documents | **Get Item** |
| Profile System | Documents | **Save and Update Item** |
| Profile System | Documents | **Delete Item** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- Schema — Schema information.
  - `title` string, required — Schema title.
  - `type` string, required — Schema type.
  - `description` string, required — Schema's human readable description.
  - `required` string[], required — Schema required fields.
  - `properties` object, required — Object describing each field in your desired schema. In this object, each property is a new object, describing the field according to: `type` (string); `sensitive` (boolean); `pii` (boolean) and `items.type` (if field is array).
    - `additionalProperties` object — Schema of any given field described in the `properties` field.
      - `type` string, required — Schema property type.
      - `sensitive` boolean, required — Indicates whether the property is sensitive data. Set to `true` if `pii` is `true` and set to `false` if `pii` is `false`.
      - `pii` boolean, required — Indicates whether the property is Personal Identifiable Information (PII).
      - `items` object — Object containing the type of the items if the field is an array. Typically, arrays will contain strings and will be used for fields such as `email`.
        - `type` string — Field type.
  - `documentTTL` integer — Document time to live, in days. After this many days from its creation or update, any document cerated from this schema will be deleted.
  - `version` integer — Schema version.
  - `v-indexed` string[] — List of fields to be indexed.
  - `v-unique` string[] — List of fields that must be unique.

---

[API](https://skmtc.net/vtex/apis/profile-system-pii-data-architecture.md) · [All operations](https://skmtc.net/vtex/apis/profile-system-pii-data-architecture/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/profile-system-pii-data-architecture/revisions/23729fa2a727/schema)