> For the complete documentation index, see [llms.txt](https://docs.fylr.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fylr.io/for-developers/api/endpoints/api-mask.md).

# /api/v1/mask

Access the **mask** definitions of a datamodel version. Masks project objecttypes to a subset of fields and are the unit through which the frontend renders forms and detail views. `version` can be:

* `HEAD` — the working copy (uncommitted edits). Readable by any authenticated user (`GET` requires only an authenticated user, not `system.datamodel`).
* `CURRENT` — the most recently committed version. Resolved server-side; equivalent to the highest committed number.
* a positive integer pointing at a specific committed version.

### `GET /mask/{version}` — Retrieve all masks for a datamodel version.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/mask/{version}" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /mask/{version}/{mask}` — Retrieve a single mask of a datamodel version.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/mask/{version}/{mask}" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `POST /mask/HEAD` — Write masks into the working datamodel (`HEAD`).

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/mask/HEAD" method="post" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}